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

Only build submodule docs which are included in toctrees #18

Closed
eharkins opened this issue Oct 1, 2020 · 1 comment
Closed

Only build submodule docs which are included in toctrees #18

eharkins opened this issue Oct 1, 2020 · 1 comment
Labels
enhancement New feature or request

Comments

@eharkins
Copy link
Contributor

eharkins commented Oct 1, 2020

It seems like the build tries to also build the augur and cli api docs, which are not included in any of the toctree statements and so are not reachable by any links in the main documentation (intentionally - since they are in their respective subprojects). Because of this, we could optimize the build by not building these docs in the main documentation build since we don't need them, and to get rid of warnings like this:

/Users/eharkins/nextstrain/docs.nextstrain.org/src/augur/docs/usage/cli/version.rst:5: WARNING: Failed to import "make_parser" from "augur".                  
No module named 'augur'                                                                                                                                       
/Users/eharkins/nextstrain/docs.nextstrain.org/src/cli/doc/commands/build.rst:5: WARNING: Failed to import "make_parser" from "nextstrain.cli".               
No module named 'nextstrain.cli' 
@eharkins eharkins added the enhancement New feature or request label Oct 19, 2020
@eharkins
Copy link
Contributor Author

#36 removed submodules. In general, to exclude docs from the build, we use https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-exclude_patterns

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant