Description of your problem
When trying to build the docs, all the notebook sections fail to make it into the built html.
(venv)% python -m pip install .
(venv)% python -m pip install -r requirements-dev.txt
(venv)% latesttag=$(git describe --tags `git rev-list --tags --max-count=1`)
(venv)% git checkout ${latesttag}
(venv)% git submodule update --remote
(venv)% cd docs/source
(venv)% make html
# Countless warnings about ipynb files not being included in the toctree
/Users/pawlu/Documents/personal/pymc3/docs/source/pymc-examples/examples/pymc3_howto/sampling_callback.ipynb: WARNING: document isn't included in any toctree
(venv)% open source/_build/html/index.html
...
As expected by the warnings, the sections derived from the example notebooks are blank. I tried to follow the steps outlied in build_and_deploy_docs.sh as close as possible, but am clearly still missing a step. The notebook files do exist in docs/source/pymc-examples, so I think they were cloned correctly.
- Am I missing a step here in properly building the docs?
- How can we make this process easier for first time contributers?
Thanks for the amazing library and documentation!
Description of your problem
When trying to build the docs, all the notebook sections fail to make it into the built html.
As expected by the warnings, the sections derived from the example notebooks are blank. I tried to follow the steps outlied in
build_and_deploy_docs.shas close as possible, but am clearly still missing a step. The notebook files do exist indocs/source/pymc-examples, so I think they were cloned correctly.Thanks for the amazing library and documentation!