Skip to content

Commit 4758b85

Browse files
author
Release Manager
committed
gh-40587: Minor documentation formatting improvement And redirect readers to the page. I think developers are most likely to want to build the documentation. I think we should ignore the test-new failure, which is likely an oversight introduced in #39641 . As long as the corresponding test pass in test-long it should be fine. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [ ] The title is concise and informative. - [ ] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - #12345: short description why this is a dependency --> <!-- - #34567: ... --> URL: #40587 Reported by: user202729 Reviewer(s): Tobias Diez
2 parents d5a1370 + 33c1f75 commit 4758b85

File tree

3 files changed

+16
-4
lines changed

3 files changed

+16
-4
lines changed

pkgs/sage-docbuild/README.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
Sage: Open Source Mathematics Software: Build system of the Sage documentation
33
================================================================================
44

5+
.. NOTE::
6+
7+
If you are a developer and want to build the SageMath documentation from source,
8+
refer to `developer's guide <../../developer/sage_manuals.html>`_.
9+
510
About SageMath
611
--------------
712

src/doc/en/developer/sage_manuals.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,9 @@ function's documentation. Type::
7777
Hyperlinks
7878
==========
7979

80-
The documentation can contain links toward modules, classes, or methods, e.g.::
80+
The documentation can contain links toward modules, classes, or methods, e.g.:
81+
82+
.. CODE-BLOCK:: rest
8183
8284
:mod:`link to a module <sage.module_name>`
8385
:mod:`sage.module_name` (here the link's text is the module's name)
@@ -335,7 +337,7 @@ links that it contains, use the ``--warn-links`` flag. Note that Sphinx will not
335337
rebuild a document that has not been updated, and thus not report its broken
336338
links::
337339

338-
sage --docbuild --warn-links reference html
340+
sage --docbuild --warn-links reference html
339341

340342
.. _section-manuals-names:
341343

src/sage_docbuild/builders.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
"""
33
Documentation builders
44
5+
.. NOTE::
6+
7+
If you are a developer and want to build the SageMath documentation from source,
8+
refer to `developer's guide <../../../developer/sage_manuals.html>`_.
9+
510
This module is the starting point for building documentation, and is
611
responsible to figure out what to build and with which options. The actual
712
documentation build for each individual document is then done in a subprocess
@@ -21,7 +26,7 @@
2126
in ``local/share/inventory``.
2227
2328
The reference manual is built in two passes, first by :class:`ReferenceBuilder`
24-
with ``inventory`` output type and secondly with``html`` output type. The
29+
with ``inventory`` output type and secondly with ``html`` output type. The
2530
:class:`ReferenceBuilder` itself uses :class:`ReferenceTopBuilder` and
2631
:class:`ReferenceSubBuilder` to build subcomponents of the reference manual.
2732
The :class:`ReferenceSubBuilder` examines the modules included in the
@@ -318,7 +323,7 @@ def clean(self, *args):
318323

319324
def build_many(target, args, processes=None):
320325
"""
321-
Thin wrapper around `sage_docbuild.utils.build_many` which uses the
326+
Thin wrapper around :func:`sage_docbuild.utils.build_many` which uses the
322327
docbuild settings ``NUM_THREADS`` and ``ABORT_ON_ERROR``.
323328
"""
324329
if processes is None:

0 commit comments

Comments
 (0)