io-aero / io-template-lib

Template for Library Repositories
Other
0 stars 0 forks source link

Documentation issues #3

Closed walter-weinmann closed 1 year ago

walter-weinmann commented 1 year ago
DELETE_SPHINX_1 =del /f /q docs\\build\\*
DELETE_SPHINX_2 =del /f /q docs\\source\\modules.rst
PIPENV          =pipenv
SPHINX_BUILDDIR =docs\\build
SPHINX_SOURCEDIR=docs\\source
----------------------------------------------------------------------
del /f /q docs\\build\\*
cd
D:\SoftDevelopment\Projects\IO-Aero\io-template-lib
pipenv run sphinx-apidoc -o docs\\source iotemplatelib scripts
File docs\source\iotemplatelib.rst already exists, skipping.
Creating file docs\source\modules.rst.
del /f /q docs\\source\\modules.rst
pipenv run sphinx-build -M html docs\\source docs\\build
Running Sphinx v7.1.2
loading pickled environment... done
myst v2.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions=set(), disable_syntax=[], all_links_external=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 3 changed, 0 removed
reading sources... [100%] setup
WARNING: autodoc: failed to import module 'io_glob' from module 'iotemplatelib'; the following exception was raised:
No module named 'iotemplatelib'
WARNING: autodoc: failed to import module 'io_logger' from module 'iotemplatelib'; the following exception was raised:
No module named 'iotemplatelib'
WARNING: autodoc: failed to import module 'io_settings' from module 'iotemplatelib'; the following exception was raised:
No module named 'iotemplatelib'
WARNING: autodoc: failed to import module 'iotemplatelib'; the following exception was raised:
No module named 'iotemplatelib'
WARNING: autodoc: failed to import module 'launcher'; the following exception was raised:
No module named 'launcher'
WARNING: autodoc: failed to import module 'setup'; the following exception was raised:
No module named 'setup'
looking for now-outdated files... none found
pickling environment... done
checking consistency... D:\SoftDevelopment\Projects\IO-Aero\io-template-lib\docs\source\img\README.md: WARNING: document isn't included in any toctree
D:\SoftDevelopment\Projects\IO-Aero\io-template-lib\docs\source\launcher.rst: WARNING: document isn't included in any toctree
D:\SoftDevelopment\Projects\IO-Aero\io-template-lib\docs\source\setup.rst: WARNING: document isn't included in any toctree
done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done
writing output... [100%] setup
generating indices... genindex done
highlighting module code...
writing additional pages... search done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 9 warnings.

The HTML pages are in docs\build\html.
cd ..
Info **********  End:   sphinx ***************************************
walter-weinmann commented 1 year ago

Looks fine.