Added make target to create a bare apidoc and nitpick test it. #270
Conversation
This file contains 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
lucianopaz
added
help wanted
make.bat
Outdated
| --full --separate --module-first ^ | ||
| -o test_docs %PACKAGE_DIR% && ^ | ||
| sphinx-build -nWT test_docs\ test_docs\_build\ |
There was a problem hiding this comment.
Suggested change
| sphinx-build -nWT test_docs\ test_docs\_build\ | |
| sphinx-build -nWT test_docs\ test_docs\_build\ |
This is amazing! Small nitpick otherwise it gives error ' sphinx-build' is not recognized....
I was trying to build docs on my windows system and got the error
Warning, treated as error:
autodoc: failed to import module 'pymc4'; the following exception was raised:
No module named 'pymc4'
and I am not able to build docs. Is there a way to get around this?
There was a problem hiding this comment.
Thanks @tirthasheshpatel. It looks like you hadn't installed pymc4 before trying to build the docs. You need to install it first
There was a problem hiding this comment.
Thanks! Works now!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 closes #264.
However, it highlights that some of the current docstrings are broken, so we will have to fix them before being able to merge. Also, we need to include the extensions for plotting and configure the intersphinx mapping to prevent the damned entity not found warnings.
If anyone is willing to help fixing the docstrings to prevent sphinx warnings, it would be great. Just push edits to
lucianopaz/pymc4 iss264