benji-york / manuel

Manuel lets you mix and match traditional doctests with custom test syntax.
Apache License 2.0
18 stars 15 forks source link

1.11.2: sphinx documentation not finished? #31

Open kloczek opened 2 years ago

kloczek commented 2 years ago

Yeah .. looks like at least sphinx/index.rst is missing

+ /usr/bin/sphinx-build -n -T -b man sphinx build/sphinx/man
Running Sphinx v4.5.0
making output directory... done
myst v0.17.2: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions=[], 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', disable_syntax=[], all_links_external=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, highlight_code_blocks=True, number_code_blocks=[], title_to_header=False, heading_anchors=None, heading_slug_func=None, footnote_transition=True, sub_delimiters=('{', '}'), words_per_minute=200)
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 0 added, 0 changed, 0 removed

Traceback (most recent call last):
  File "/usr/lib/python3.8/site-packages/sphinx/cmd/build.py", line 276, in build_main
    app.build(args.force_all, filenames)
  File "/usr/lib/python3.8/site-packages/sphinx/application.py", line 330, in build
    self.builder.build_update()
  File "/usr/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 283, in build_update
    self.build(['__all__'], to_build)
  File "/usr/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 300, in build
    updated_docnames = set(self.read())
  File "/usr/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 410, in read
    raise SphinxError('root file %s not found' %
sphinx.errors.SphinxError: root file /home/tkloczko/rpmbuild/BUILD/manuel-1.11.2/sphinx/index.rst not found

Sphinx error:
root file /home/tkloczko/rpmbuild/BUILD/manuel-1.11.2/sphinx/index.rst not found

BTW. sphinx<>setuptools integration uses as default location of the copy.py file docs/copy.py so if that is still not finished maybe it would be good to rename sphinx/->docs/? (it would be possible to use python setup.py build_sphinx command as well).

kloczek commented 2 years ago

gentle ping 😋