search

G-Node / nix

Neuroscience information exchange format
https://readthedocs.org/projects/nixio/
Other
66 stars 36 forks source link

docs ready for ReadTheDocs #776

Closed jgrewe closed 5 years ago

achilleas-k commented 5 years ago

Builds and looks good, but I'm getting some warnings when building locally.

/Users/achilleas/code/nix/docs/getting_started.rst:61: WARNING: toctree contains reference to nonexisting document 'example_guide'
/Users/achilleas/code/nix/docs/index.rst:115: WARNING: toctree contains reference to nonexisting document 'contact'
/Users/achilleas/code/nix/docs/getting_started.rst:47: WARNING: unknown document: example_guide
/usr/local/lib/python3.7/site-packages/sphinx_rtd_theme/search.html:20: RemovedInSphinx30Warning: To modify script_files in the theme is deprecated. Please insert a <script> tag directly in your theme instead.
  {{ super() }}
WARNING: html_static_path entry '/Users/achilleas/code/nix/docs/_static' does not exist

Are you getting the same? We should probably deal with them before merging since the docs don't get frequent attention.

jgrewe commented 5 years ago

thanks @achilleas-k, all files are now in the repo, warnings are fixed, one thing that I would like to have is to also include the doxygen api documentation... need to play around with this, maybe a second step

achilleas-k commented 5 years ago

Still missing example_guide and conf.py has html_static_path = ['_static'] but there's no _static directory.

jgrewe commented 5 years ago

@achilleas-k please try again :)

achilleas-k commented 5 years ago

Perfect :D