DeepDriveMD / DeepDriveMD-pipeline

DeepDriveMD: Deep-Learning Driven Adaptive Molecular Simulations
MIT License
15 stars 9 forks source link

Bug in rst docs, not displaying autodoc deepdrivemd.data.utils #25

Closed braceal closed 3 years ago

braceal commented 3 years ago

To reproduce:

  1. Follow installation instructions in readme.
  2. git checkout feature/docs
  3. cd docs
  4. make html

Desired: Show a page with the deepdrivemd.data.utils autodoc display, linked from page 2.

Output:

Running Sphinx v3.3.1
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 4 source files that are out of date
updating environment: 0 added, 4 changed, 0 removed
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index
/Users/abrace/src/DeepDriveMD-pipeline/docs/source/documentation_pages/deepdrivemd_api.rst:7: WARNING: toctree contains reference to document 'documentation_pages/deepdrivemd_api_modules/utils' that doesn't have a title: no link will be generated
/Users/abrace/src/DeepDriveMD-pipeline/docs/source/documentation_pages/deepdrivemd_api.rst:7: WARNING: toctree contains reference to document 'documentation_pages/deepdrivemd_api_modules/utils' that doesn't have a title: no link will be generated
/Users/abrace/src/DeepDriveMD-pipeline/docs/source/documentation_pages/deepdrivemd_api.rst:7: WARNING: toctree contains reference to document 'documentation_pages/deepdrivemd_api_modules/utils' that doesn't have a title: no link will be generated
generating indices... genindex py-modindex done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 3 warnings.
braceal commented 3 years ago

Fixed by adding a title to utils.rst.