Fix Sphinx docs build errors and align HTML output with source (issue #1432)#1433
Merged
Conversation
Closed
Copilot
AI
changed the title
[WIP] Align documentation with source code
Fix Sphinx docs build errors and align HTML output with source (issue #1432)
Jul 18, 2026
SkBlaz
marked this pull request as ready for review
July 20, 2026 19:57
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Sphinx build had dozens of RST parse errors and broken references preventing a clean docs rebuild, leaving the published HTML misaligned with current source.
RST / docfiles fixes
conf.py— Addedautodoc_mock_imports = ['gensim', 'rdflib']andsphinx.ext.todoto eliminate import errors during autodocreference/api_index.rst— Added:no-index:to all 98automodule::directives; these shadowedapidocs.rstand generated hundreds of duplicate-object warningsreference/algorithm_reference.rst— Removed 26 duplicate.. _label:anchors that collided withalgorithm_roadmap.rstuser_guide/recipes_and_workflows.rst— Renamed.. _recipes:→.. _user-recipes:(label collision)reference/layer_set_algebra.rst— Escaped bare*after=to prevent unclosed-emphasis parse errorquery_with_patterns.rst— Repaired 2 malformed grid tables and 24 broken section underlinesquery_zoo.rst,examples_reference.rst— Removed brokenliteralincludeblocks referencing non-existent filesrun_community_detection.rst,simulate_dynamics.rst— Replaced broken:download:refs with direct GitHub linksmultilayer_in_2min.rst— Fixed underline length mismatchPython docstring fixes
Sphinx parses docstrings as RST; these patterns caused hard errors:
|pipe|substitution references —|Z|,|Z_observed|,|z-score|,O(|V|)rewritten as plain prose acrossnull_models.py,ast.py**kwargsbold markup — Wrapped as**kwargsinio/api.py'-|>'arrowstyle literal — Escaped to'-\\|>'indrawing_machinery.pyArgs:blocks — Flattened to prose inbuilder.py(aggregate,mutate),partition.pyresult.pyto_pandasdocstring*.edges→\*.edgesinparsers.pyRebuilt HTML
Docs rebuilt via
sphinx-build -b html; output (zero errors) copied todocs/for GitHub Pages. Remaining 132 warnings are all non-blocking: 65toc.not_includednotices, missing images in visualization guide, and external sklearn glossary references outside this codebase.