Skip to content

Clean up the html docs for the dataframe API standard #152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Apr 27, 2023

Conversation

rgommers
Copy link
Member

This culls some boilerplate and brings a bit of method to the autodoc madness. All GroupBy, Column and DataFrame methods are now automatically included, and the front page of the API specification is much easier to read.

Finally, removes two empty pages (benchmarking and usage data) that we are unlikely to fill any time soon.

@rgommers rgommers added the documentation Improvements or additions to documentation label Apr 26, 2023
@rgommers rgommers force-pushed the html-docs branch 3 times, most recently from 0d6ea4e to 32cca8b Compare April 27, 2023 00:00
@rgommers
Copy link
Member Author

The rendering wasn't great here compared to what I had locally, but unfortunately between Sphinx, docutils and myst-parser it's almost impossible to find a warning-free or bug-free version. Myst has a pretty bad bug where cross-references between .md docs no longer work: executablebooks/MyST-Parser#749. Causing this:

/home/circleci/repo/spec/use_cases.md:7: WARNING: local id not found in doc 'purpose_and_scope': 'Goals' [myst.xref_missing]
/home/circleci/repo/spec/use_cases.md:7: WARNING: local id not found in doc 'purpose_and_scope': 'Scope' [myst.xref_missing]
/home/circleci/repo/spec/use_cases.md:10: WARNING: local id not found in doc 'purpose_and_scope': 'Stakeholders' [myst.xref_missing]

For now I'll drop these cross-links to get to green.

@rgommers
Copy link
Member Author

Better - preview in Circle CI looks quite nice now.

@MarcoGorelli MarcoGorelli merged commit f690016 into data-apis:main Apr 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants