pepoluan
commented
1 year ago Hmm, that is strange. Because one of the steps for GitHub Actions -- which is run on every commit to master -- is to build the documentation, and so far it always passes. I also can run the tox qa in my Windows laptop, and it passes as well.
Have you installed all docs dependencies as listed in aiosmtpd/docs/RTD-requirements.txt ?
Because I noted you have this error: ModuleNotFoundError: No module named 'public'
(You might want to install colorama as well to get nice colored Sphinx output.)
Basically, just follow the steps as listed in tox.ini or the steps in GitHub Actions
dvzrv
webknjaz
aiosmtpd/docs is included in generated .whl archive
This can be fixed by move aiosmtpd/docs to docs/
documentation build fail First of all looks like in conf.py is missing add path to the aiosmtpd tree so I've added patch
But even with that it is not possible to build documentation
/usr/bin/sphinx-build -n -T -b man aiosmtpd/docs build/sphinx/man Running Sphinx v5.3.0 Inserting /home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.4 Inserting /home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.4/aiosmtpd/docs/_exts Inserting /home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.4/aiosmtpd making output directory... done loading intersphinx inventory from https://docs.python.org/3/objects.inv... building [mo]: targets for 0 po files that are out of date building [man]: all manpages updating environment: [new config] 14 added, 0 changed, 0 removed reading sources... [ 71%] manpage Traceback (most recent call last): File "/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.4/aiosmtpd/docs/_exts/autoprogramm.py", line 158, in import_object mod = import(module_name) File "/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.4/aiosmtpd/main.py", line 16, in
from public import public
ModuleNotFoundError: No module named 'public'
During handling of the above exception, another exception occurred:
Traceback (most recent call last): File "/usr/lib/python3.8/site-packages/sphinx/cmd/build.py", line 281, in build_main app.build(args.force_all, args.filenames) File "/usr/lib/python3.8/site-packages/sphinx/application.py", line 347, in build self.builder.build_update() File "/usr/lib/python3.8/site-packages/sphinx/builders/init.py", line 307, in build_update self.build(['all'], to_build) File "/usr/lib/python3.8/site-packages/sphinx/builders/init.py", line 326, in build updated_docnames = set(self.read()) File "/usr/lib/python3.8/site-packages/sphinx/builders/init.py", line 433, in read self._read_serial(docnames) File "/usr/lib/python3.8/site-packages/sphinx/builders/init.py", line 454, in _read_serial self.read_doc(docname) File "/usr/lib/python3.8/site-packages/sphinx/builders/init.py", line 510, in read_doc publisher.publish() File "/usr/lib/python3.8/site-packages/docutils/core.py", line 224, in publish self.document = self.reader.read(self.source, self.parser, File "/usr/lib/python3.8/site-packages/sphinx/io.py", line 104, in read self.parse() File "/usr/lib/python3.8/site-packages/docutils/readers/init.py", line 76, in parse self.parser.parse(self.input, document) File "/usr/lib/python3.8/site-packages/sphinx/parsers.py", line 78, in parse self.statemachine.run(inputlines, document, inliner=self.inliner) File "/usr/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 169, in run results = StateMachineWS.run(self, input_lines, input_offset, File "/usr/lib/python3.8/site-packages/docutils/statemachine.py", line 233, in run context, next_state, result = self.check_line( File "/usr/lib/python3.8/site-packages/docutils/statemachine.py", line 445, in check_line return method(match, context, next_state) File "/usr/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 3024, in text self.section(title.lstrip(), source, style, lineno + 1, messages) File "/usr/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 325, in section self.new_subsection(title, lineno, messages) File "/usr/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 391, in new_subsection newabsoffset = self.nested_parse( File "/usr/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 279, in nested_parse state_machine.run(block, input_offset, memo=self.memo, File "/usr/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 195, in run results = StateMachineWS.run(self, input_lines, input_offset) File "/usr/lib/python3.8/site-packages/docutils/statemachine.py", line 233, in run context, next_state, result = self.check_line( File "/usr/lib/python3.8/site-packages/docutils/statemachine.py", line 445, in check_line return method(match, context, next_state) File "/usr/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 2785, in underline self.section(title, source, style, lineno - 1, messages) File "/usr/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 325, in section self.new_subsection(title, lineno, messages) File "/usr/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 391, in new_subsection newabsoffset = self.nested_parse( File "/usr/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 279, in nested_parse state_machine.run(block, input_offset, memo=self.memo, File "/usr/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 195, in run results = StateMachineWS.run(self, input_lines, input_offset) File "/usr/lib/python3.8/site-packages/docutils/statemachine.py", line 233, in run context, next_state, result = self.check_line( File "/usr/lib/python3.8/site-packages/docutils/statemachine.py", line 445, in check_line return method(match, context, next_state) File "/usr/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 2355, in explicit_markup nodelist, blank_finish = self.explicit_construct(match) File "/usr/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 2367, in explicit_construct return method(self, expmatch) File "/usr/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 2104, in directive return self.run_directive( File "/usr/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 2154, in run_directive result = directive_instance.run() File "/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.4/aiosmtpd/docs/_exts/autoprogramm.py", line 294, in run for line in self.make_rst(): File "/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.4/aiosmtpd/docs/_exts/autoprogramm.py", line 209, in make_rst parser = import_object(import_name or "undefined") File "/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.4/aiosmtpd/docs/_exts/autoprogramm.py", line 181, in import_object raise ImportError("No module named {}".format(module_name)) ImportError: No module named aiosmtpd.main
Exception occurred: File "/home/tkloczko/rpmbuild/BUILD/aiosmtpd-1.4.4/aiosmtpd/docs/_exts/autoprogramm.py", line 181, in import_object raise ImportError("No module named {}".format(module_name)) ImportError: No module named aiosmtpd.main The full traceback has been saved in /tmp/sphinx-err-v4kv9ql8.log, if you want to report the issue to the developers. Please also report this if it was a user error, so that a better error message can be provided next time. A bug report can be filed in the tracker at https://github.com/sphinx-doc/sphinx/issues. Thanks!