-
Notifications
You must be signed in to change notification settings - Fork 148
Description
Sadly (?) this is only happening on 1 (private) repo and I don't have a clue why yet. We have a dozen or so repos with essentially the same sphinx build and doorstop doc items as shown here. I'd be happy to test and report more info but I need something to try.
Note the doc setup in question uses some tox _pre commands to publish each prefix to a subdir of the sphinx doc sources that contains a "target" assets folder and we treat the contents the same as the (generated) api doc sources in that they get removed during docs clean and regenerated with each docs build. If I remove the (target) assets folder, doorstop will create an empty folder without any svg files.
Each repo contains 3 or 4 doorstop docs but only one doc folder (in each repo) includes an assets folder.
I did some issue searching but I didn't find anything recent, and the problem repo was working fine when I stopped touching it several weeks ago.
Successful output:
$ tox -e docs
docs: commands_pre[0]> doorstop publish REQ docs/source/ds/reqs_tree.md
building tree...
publishing document REQ to '/home/user/src/rpmget/docs/source/ds/reqs_tree.md'...
published: /home/user/src/rpmget/docs/source/ds/reqs_tree.md
docs: commands_pre[1]> doorstop publish TST docs/source/ds/unit_tests.md
building tree...
publishing document TST to '/home/user/src/rpmget/docs/source/ds/unit_tests.md'...
published: /home/user/src/rpmget/docs/source/ds/unit_tests.md
docs: commands_pre[2]> doorstop publish SDD docs/source/ds/sw_design.md
building tree...
publishing document SDD to '/home/user/src/rpmget/docs/source/ds/sw_design.md'...
published: /home/user/src/rpmget/docs/source/ds/sw_design.md
docs: commands_pre[3]> bash docs/sphinx_prep.sh docs/source/ds/reqs_tree.md
Processing markdown file: docs/source/ds/reqs_tree.md
Success
docs: commands_pre[4]> bash docs/sphinx_prep.sh docs/source/ds/unit_tests.md
Processing markdown file: docs/source/ds/unit_tests.md
Success
docs: commands_pre[5]> bash docs/sphinx_prep.sh docs/source/ds/sw_design.md
Processing markdown file: docs/source/ds/sw_design.md
Success
docs: commands[0]> make -C docs html
make: Entering directory '/home/user/src/rpmget/docs'
Running Sphinx v7.4.7
loading translations [en]... done
making output directory... done
Creating file /home/user/src/rpmget/docs/source/api/rpmget.rst.
Creating file /home/user/src/rpmget/docs/source/api/rpmget.rpmget.rst.
Creating file /home/user/src/rpmget/docs/source/api/rpmget.utils.rst.
Creating file /home/user/src/rpmget/docs/source/api/modules.rst.
myst v4.0.1: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions=set(), disable_syntax=[], all_links_external=False, links_external_new_tab=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_sort=True, 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 9 source files that are out of date
updating environment: [new config] 13 added, 0 changed, 0 removed
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets...
copying static files... done
copying extra files... done
copying assets: done
writing output... [100%] index
generating indices... genindex py-modindex done
highlighting module code... [100%] rpmget.utils
writing additional pages... search done
copying images... [100%] ds/assets/rpmget_dependency_graph.svg
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.
The HTML pages are in _build/html.
make: Leaving directory '/home/user/src/rpmget/docs'
docs: OK (2.50=setup[0.03]+cmd[0.28,0.62,0.62,0.00,0.00,0.00,0.94] seconds)
congratulations :) (2.54 seconds)
Where Sphinx finds the image files ^^ just fine.
Unsuccessful output:
$ tox -e docs
docs: commands_pre[0]> doorstop --verbose publish SRS docs/source/ds/SRS_reqs_tree.md
building tree...
publishing document SRS to '/home/user/src/swupdate-tui/docs/source/ds/SRS_reqs_tree.md'...
published: /home/user/src/swupdate-tui/docs/source/ds/SRS_reqs_tree.md
docs: commands_pre[1]> doorstop --verbose publish TUI docs/source/ds/TUI_reqs_tree.md
building tree...
publishing document TUI to '/home/user/src/swupdate-tui/docs/source/ds/TUI_reqs_tree.md'...
published: /home/user/src/swupdate-tui/docs/source/ds/TUI_reqs_tree.md
docs: commands_pre[2]> doorstop --verbose publish TSWD docs/source/ds/TUI_sw_design.md
building tree...
publishing document TSWD to '/home/user/src/swupdate-tui/docs/source/ds/TUI_sw_design.md'...
published: /home/user/src/swupdate-tui/docs/source/ds/TUI_sw_design.md
docs: commands_pre[3]> doorstop --verbose publish TUNT docs/source/ds/TUI_unit_tests.md
building tree...
publishing document TUNT to '/home/user/src/swupdate-tui/docs/source/ds/TUI_unit_tests.md'...
published: /home/user/src/swupdate-tui/docs/source/ds/TUI_unit_tests.md
docs: commands_pre[4]> bash scripts/sphinx_prep.sh docs/source/ds/SRS_reqs_tree.md
Processing markdown file: docs/source/ds/SRS_reqs_tree.md
Success
docs: commands_pre[5]> bash scripts/sphinx_prep.sh docs/source/ds/TUI_reqs_tree.md
Processing markdown file: docs/source/ds/TUI_reqs_tree.md
Success
docs: commands_pre[6]> bash scripts/sphinx_prep.sh docs/source/ds/TUI_sw_design.md
Processing markdown file: docs/source/ds/TUI_sw_design.md
Success
docs: commands_pre[7]> bash scripts/sphinx_prep.sh docs/source/ds/TUI_unit_tests.md
Processing markdown file: docs/source/ds/TUI_unit_tests.md
Success
docs: commands[0]> make -C docs html
make: Entering directory '/home/user/src/swupdate-tui/docs'
Running Sphinx v7.4.7
loading translations [en]... done
loading pickled environment... done
Creating file /home/user/src/swupdate-tui/docs/source/api/maintui.rst.
Creating file /home/user/src/swupdate-tui/docs/source/api/maintui.tui_helpers.rst.
Creating file /home/user/src/swupdate-tui/docs/source/api/modules.rst.
myst v4.0.1: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'attrs_inline', 'fieldlist', 'deflist', 'substitution'}, disable_syntax=[], all_links_external=False, links_external_new_tab=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_sort=True, 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 4 source files that are out of date
updating environment: 0 added, 4 changed, 0 removed
reading sources... [100%] ds/TUI_unit_tests
/home/user/src/swupdate-tui/docs/source/ds/TUI_sw_design.md:39: WARNING: image file not readable: ds/assets/tui_sequence_diagram.svg
/home/user/src/swupdate-tui/docs/source/ds/TUI_sw_design.md:65: WARNING: image file not readable: ds/assets/tui_dependency_graph.svg
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets...
copying static files... done
copying extra files... done
copying assets: done
writing output... [100%] index
/home/user/src/swupdate-tui/docs/source/ds/TUI_sw_design.md:71: WARNING: Pygments lexer name 'mermaid' is not known
generating indices... genindex py-modindex done
highlighting module code... [100%] maintui.tui_helpers
writing additional pages... search done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 3 warnings.
The HTML pages are in _build/html.
make: Leaving directory '/home/user/src/swupdate-tui/docs'
docs: OK (2.42=setup[0.03]+cmd[0.28,0.29,0.57,0.56,0.00,0.00,0.00,0.00,0.68] seconds)
congratulations :) (2.47 seconds)