Skip to content

Misc fixes needed to build docs locally #99

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 2 commits into from
May 10, 2023

Conversation

dstansby
Copy link
Member

@dstansby dstansby commented May 10, 2023

Does what it says in the title.

To test locally:

python -m pip install -e ".[docs]"
cd docs
make html

The HTML docs should then be built succesfully in the _build/html directory.

@dstansby dstansby marked this pull request as ready for review May 10, 2023 09:22
@dstansby dstansby requested review from samcunliffe and ruaridhg May 10, 2023 09:22
Copy link
Collaborator

@samcunliffe samcunliffe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🍉

Tested locally, works.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to confirm, this all now comes from docs/api.rst right? The automodapi directive handles all of this for us.

I never used the sphinx-automodapi extension (and it looks like it would have saved me a lot of time).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Astrophysicists makin' cool toys.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that's right. This should never have been committed 🙈

@samcunliffe samcunliffe added this pull request to the merge queue May 10, 2023
Merged via the queue into matplotlib:main with commit cbe215f May 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants