Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions manual/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -159,10 +159,10 @@ doctest: $(SPHINXBUILD)
"results in $(BUILDDIR)/doctest/output.txt."

.PHONY: tools
tools: tool/bin/pip requirements.pip
tool/bin/pip install -r requirements.pip
tools: $(SPHINXBUILD)

tool/bin/sphinx-build: tools
$(SPHINXBUILD): tool/bin/pip requirements.pip
tool/bin/pip install -r requirements.pip

tool/bin/pip:
$(PYTHON) -mvenv tool
6 changes: 3 additions & 3 deletions manual/requirements.pip
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# manual/requirements.txt -- MPS manual build requirements for pip
# manual/requirements.pip -- MPS manual build requirements for pip

# Layout breaks in Sphinx >= 5. See <https://github.com/Ravenbrook/mps/issues/121>.
sphinx >= 4, < 5
sphinx
sphinx-rtd-theme
40 changes: 40 additions & 0 deletions manual/source/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{# manual/source/_templates/layout.html -- add index to manual sidebar.
#
# See https://stackoverflow.com/a/37843854 .
#}

{% extends "!layout.html" %}

{% block menu %}
{{ super() }}

<p class="caption" role="heading">
<span class="caption-text">Indices and tables</span>
</p>

<ul>

{# The class toctree-l1 seems to correspond to list items generated
by a Sphinx toctree directive that are at depth 1. I have not
found documented confirmation of this but it is confirmed
`_toctree_add_classes
<https://github.com/sphinx-doc/sphinx/blob/bb74aec2b6aa1179868d83134013450c9ff9d4d6/sphinx/environment/adapters/toctree.py#L403-L430>`_
in the Sphinx source code. If the list layout goes wonky, this
might be to blame. RB 2023-10-20. #}

<li class="toctree-l1">

<a class="reference internal" href="{{pathto('genindex.html', 1)}}">Index</a>

{# Module index and search page aren't used in the MPS manual but
might be in future. This is how they might be added. #}

{# <a class="reference internal" href="{{pathto('modindex.html', 1)}}">Module Index</a> #}

{# <a class="reference internal" href="{{pathto('search.html', 1)}}">Search Page</a> #}

</li>

</ul>

{% endblock %}
12 changes: 11 additions & 1 deletion manual/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,17 @@
else:
project = u'Memory Pool System'
master_doc = 'index'
html_theme = 'mps'
# We use the Read the Docs theme for Sphinx for smooth publishing
# at readthedocs.io, low maintenance overheads, local search, etc.
# See primarily `GitHub issue #98
# <https://github.com/Ravenbrook/mps/issues/98>`_ but also `GitHub
# issue #121 <https://github.com/Ravenbrook/mps/issues/121>`_ .
# See <https://sphinx-rtd-theme.readthedocs.io/> for theme
# documentation.
html_theme = 'sphinx_rtd_theme'
html_theme_options = {
'includehidden': False,
}
html_sidebars = {
'**': ['localtoc.html', 'relations.html', 'links.html', 'contact.html'],
}
Expand Down
Loading