Fix Read the Docs badge build#2
Merged
Merged
Conversation
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
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.
Motivation
Description
.readthedocs.yamlthat instructs RTD to usedocs/conf.py, installdocs/requirements.txt, and install the package before building.docs/requirements.txtto use Sphinx/RTD/AutoAPI versions compatible with the RTD build image (pinned tosphinx==7.4.7,sphinx_rtd_theme==2.0.0,sphinx-autoapi==3.6.0).autoapi_dirsindocs/conf.pyfrom['../loica']to['../src/loica']and disable the missing_staticpath by settinghtml_static_path = [].docs/index.rst,src/loica/sample.py, andsrc/loica/geneproduct.pyto remove docstring/reST problems.Testing
cd docs && make html, and the Sphinx build completed successfully with the HTML output generated (the build emitted warnings from AutoAPI about duplicate objects but exited successfully)..readthedocs.yamlconfiguration.Codex Task