Add ci command for building documentation#566
Merged
Conversation
rahulporuri
approved these changes
Mar 10, 2021
Contributor
There was a problem hiding this comment.
LGTM. This is a good place to start. There a few issues, only one of which needs to be addressed in this PR
- it looks like the api docs are autogenerated but they aren't ignored in
.gitignoreso git sees a lot of changed/new files. <- This is the only thing that needs to be fixed in this PR. - we're building api docs but we're not linking to them in the built docs.
- we are installing
enthought_sphinx_themebut we aren't using it for the docs. - the version information seems to be hardcoded in the sphinx conf which is why i see docs for chaco 4.8.
rahulporuri
reviewed
Mar 10, 2021
Comment on lines
+304
to
+307
| api_path = os.path.join("docs", "source", "api") | ||
| if os.path.exists(api_path): | ||
| rmtree(api_path) | ||
| os.makedirs(api_path) |
Contributor
There was a problem hiding this comment.
I think this is borrowed from traitsui or pyface. Can you borrow the code from traits or traits-futures instead? It will be nice if we can borrow the sphinx api templates.
Edit : This can be done in a separate PR.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
this PR simply pulls the
docsci command from other ets projects into chaco.