Skip to content
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

Document how to build the docs #863

Merged
merged 9 commits into from
Mar 11, 2021
Merged

Document how to build the docs #863

merged 9 commits into from
Mar 11, 2021

Conversation

Yoshanuikabundi
Copy link
Collaborator

@Yoshanuikabundi Yoshanuikabundi commented Mar 3, 2021

This PR adds a section to the developers guide that describes how to build the documentation. Combined with the newly added build-on-PR status from ReadTheDocs, this should make it much easier for devs to check that their documentation is rendered correctly.

@codecov
Copy link

codecov bot commented Mar 3, 2021

Codecov Report

Merging #863 (d5d8903) into master (4fc1917) will not change coverage.
The diff coverage is n/a.

Copy link
Member

@j-wags j-wags left a comment

Choose a reason for hiding this comment

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

This is shaping up nicely. Left a few suggestions!

docs/developing.rst Outdated Show resolved Hide resolved
docs/developing.rst Show resolved Hide resolved
docs/developing.rst Outdated Show resolved Hide resolved
Copy link
Member

@j-wags j-wags left a comment

Choose a reason for hiding this comment

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

Sweet. I just reran this on my machine and it works great. This should be good to merge!

@Yoshanuikabundi
Copy link
Collaborator Author

@j-wags Codecov hates me. Could you merge this one for me when you get a chance?

BTW I left a comment in this Codecov issue with the same issue we're having.

@j-wags j-wags merged commit 637f2f0 into master Mar 11, 2021
@j-wags
Copy link
Member

j-wags commented Mar 11, 2021

Merged! Thanks Josh.

@j-wags j-wags deleted the how-to-docs branch March 11, 2021 16:27
@mattwthompson mattwthompson mentioned this pull request Mar 12, 2021
5 tasks
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