Skip to content

Local build of docs throw a bunch of warnings and two errors. #53

@alessandrofelder

Description

@alessandrofelder

Describe the bug
Local build of docs throw a bunch of warnings and two errors.

To Reproduce
Build docs locally

Expected behaviour
Docs build should not

Log file

reading sources... [100%] user_guide/key_concepts
/home/alessandro/dev/derotation/docs/source/api_index.rst:9: WARNING: toctree contains reference to nonexisting document 'derotation.analysis.bayesian_optimization' [toc.not_readable]
/home/alessandro/dev/derotation/docs/source/api_index.rst:9: WARNING: toctree contains reference to nonexisting document 'derotation.analysis.blob_detection' [toc.not_readable]
/home/alessandro/dev/derotation/docs/source/api_index.rst:9: WARNING: toctree contains reference to nonexisting document 'derotation.analysis.fit_ellipse' [toc.not_readable]
/home/alessandro/dev/derotation/docs/source/api_index.rst:9: WARNING: toctree contains reference to nonexisting document 'derotation.analysis.full_derotation_pipeline' [toc.not_readable]
/home/alessandro/dev/derotation/docs/source/api_index.rst:9: WARNING: toctree contains reference to nonexisting document 'derotation.analysis.incremental_derotation_pipeline' [toc.not_readable]
/home/alessandro/dev/derotation/docs/source/api_index.rst:9: WARNING: toctree contains reference to nonexisting document 'derotation.analysis.mean_images' [toc.not_readable]
/home/alessandro/dev/derotation/docs/source/api_index.rst:9: WARNING: toctree contains reference to nonexisting document 'derotation.analysis.metrics' [toc.not_readable]
/home/alessandro/dev/derotation/docs/source/api_index.rst:9: WARNING: toctree contains reference to nonexisting document 'derotation.config.load_config' [toc.not_readable]
/home/alessandro/dev/derotation/docs/source/api_index.rst:9: WARNING: toctree contains reference to nonexisting document 'derotation.derotate_batch' [toc.not_readable]
/home/alessandro/dev/derotation/docs/source/api_index.rst:9: WARNING: toctree contains reference to nonexisting document 'derotation.derotate_by_line' [toc.not_readable]
/home/alessandro/dev/derotation/docs/source/api_index.rst:9: WARNING: toctree contains reference to nonexisting document 'derotation.load_data.custom_data_loaders' [toc.not_readable]
/home/alessandro/dev/derotation/docs/source/api_index.rst:9: WARNING: toctree contains reference to nonexisting document 'derotation.plotting_hooks.for_derotation' [toc.not_readable]
/home/alessandro/dev/derotation/docs/source/api_index.rst:9: WARNING: toctree contains reference to nonexisting document 'derotation.sample_data' [toc.not_readable]
/home/alessandro/dev/derotation/docs/source/api_index.rst:9: WARNING: toctree contains reference to nonexisting document 'derotation.simulate.line_scanning_microscope' [toc.not_readable]
/home/alessandro/dev/derotation/docs/source/api_index.rst:9: WARNING: toctree contains reference to nonexisting document 'derotation.simulate.synthetic_data' [toc.not_readable]
/home/alessandro/dev/derotation/docs/source/examples/use_plotting_hooks.rst:36: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
/home/alessandro/dev/derotation/docs/source/index.md:10: ERROR: Invalid directive argument: argument must be 1 or 4 (xs sm md lg) values, and each value should be either auto or an integer from 1 to 12 [docutils]
/home/alessandro/dev/derotation/docs/source/user_guide/key_concepts.md:175: ERROR: Document may not end with a transition. [docutils]
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/alessandro/dev/derotation/docs/source/user_guide/configuration.md: WARNING: document isn't included in any toctree
/home/alessandro/dev/derotation/docs/source/user_guide/key_concepts.md: WARNING: document isn't included in any toctree
done
preparing documents... done
copying assets... 
copying downloadable files... [100%] examples/use_plotting_hooks.zip
copying static files... 
Writing evaluated template result to /home/alessandro/dev/derotation/docs/build/html/_static/language_data.js
Writing evaluated template result to /home/alessandro/dev/derotation/docs/build/html/_static/basic.css
Writing evaluated template result to /home/alessandro/dev/derotation/docs/build/html/_static/documentation_options.js
copying static files: done
copying extra files... 
copying extra files: done
copying assets: done
writing output... [100%] user_guide/key_concepts
/home/alessandro/dev/derotation/docs/source/user_guide/key_concepts.md:81: WARNING: Pygments lexer name 'csv' is not known

Computer used (please complete the following information):

Dell Desktop with Ubuntu 22

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions