Skip to content

Commit 97844f4

Browse files
author
Release Manager
committed
sagemathgh-39990: Remove ability to conditionalize parts of the documentation The PR sagemath#36495 introduced the ability to disable building parts of the documentation based on some features. This was meant to help the modularization project, but was never actually used. On the other hand, it checks for *every* of the around 200 document the presence of *every* feature, leading to quite a considerable overhead for building the documentation. Thus this feature is reverted for now (until it's actually needed and perhaps can be re-implemented in a better way). <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> ### 📝 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, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#39990 Reported by: Tobias Diez Reviewer(s): Dima Pasechnik
2 parents 1e5ca09 + c687717 commit 97844f4

File tree

38 files changed

+21
-248
lines changed

38 files changed

+21
-248
lines changed

src/doc/ca/intro/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@
1313
from sage_docbuild.conf import release
1414
from sage_docbuild.conf import * # NOQA
1515

16-
17-
for tag in feature_tags():
18-
tags.add(tag)
19-
20-
2116
# Add any paths that contain custom static files (such as style sheets),
2217
# relative to this directory to html_static_path. They are copied after the
2318
# builtin static files, so a file named "default.css" will overwrite the

src/doc/de/a_tour_of_sage/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,6 @@
1515
from sage_docbuild.conf import release
1616
from sage_docbuild.conf import * # NOQA
1717

18-
19-
for tag in feature_tags():
20-
tags.add(tag)
21-
22-
2318
# Add any paths that contain custom static files (such as style sheets),
2419
# relative to this directory to html_static_path. They are copied after the
2520
# builtin static files, so a file named "default.css" will overwrite the

src/doc/de/thematische_anleitungen/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@
1313
from sage_docbuild.conf import release
1414
from sage_docbuild.conf import * # NOQA
1515

16-
17-
for tag in feature_tags():
18-
tags.add(tag)
19-
20-
2116
# Add any paths that contain custom static files (such as style sheets),
2217
# relative to this directory to html_static_path. They are copied after the
2318
# builtin static files, so a file named "default.css" will overwrite the

src/doc/de/tutorial/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@
1313
from sage_docbuild.conf import release
1414
from sage_docbuild.conf import * # NOQA
1515

16-
17-
for tag in feature_tags():
18-
tags.add(tag)
19-
20-
2116
# Add any paths that contain custom static files (such as style sheets),
2217
# relative to this directory to html_static_path. They are copied after the
2318
# builtin static files, so a file named "default.css" will overwrite the

src/doc/el/a_tour_of_sage/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@
1313
from sage_docbuild.conf import release
1414
from sage_docbuild.conf import * # NOQA
1515

16-
17-
for tag in feature_tags():
18-
tags.add(tag)
19-
20-
2116
# Add any paths that contain custom static files (such as style sheets),
2217
# relative to this directory to html_static_path. They are copied after the
2318
# builtin static files, so a file named "default.css" will overwrite the

src/doc/en/a_tour_of_sage/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@
1313
from sage_docbuild.conf import release
1414
from sage_docbuild.conf import * # NOQA
1515

16-
17-
for tag in feature_tags():
18-
tags.add(tag)
19-
20-
2116
# Add any paths that contain custom static files (such as style sheets),
2217
# relative to this directory to html_static_path. They are copied after the
2318
# builtin static files, so a file named "default.css" will overwrite the

src/doc/en/constructions/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@
1313
from sage_docbuild.conf import release
1414
from sage_docbuild.conf import * # NOQA
1515

16-
17-
for tag in feature_tags():
18-
tags.add(tag)
19-
20-
2116
# Add any paths that contain custom static files (such as style sheets),
2217
# relative to this directory to html_static_path. They are copied after the
2318
# builtin static files, so a file named "default.css" will overwrite the

src/doc/en/developer/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@
1313
from sage_docbuild.conf import release
1414
from sage_docbuild.conf import * # NOQA
1515

16-
17-
for tag in feature_tags():
18-
tags.add(tag)
19-
20-
2116
# Add any paths that contain custom static files (such as style sheets),
2217
# relative to this directory to html_static_path. They are copied after the
2318
# builtin static files, so a file named "default.css" will overwrite the

src/doc/en/developer/packaging_sage_library.rst

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -495,17 +495,6 @@ requiring all of Sage to be present.
495495
mechanism mentioned above can also be used for this.
496496

497497

498-
Dependencies of the Sage documentation
499-
--------------------------------------
500-
501-
The documentation will not be modularized.
502-
503-
However, some parts of the Sage reference manual may depend on functionality
504-
provided by optional packages. These portions of the reference manual
505-
should be conditionalized using the Sphinx directive ``.. ONLY::``,
506-
as explained in :ref:`section-documentation-conditional`.
507-
508-
509498
Version constraints of dependencies
510499
-----------------------------------
511500

src/doc/en/developer/sage_manuals.rst

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -299,32 +299,6 @@ procedure is different:
299299
* Add your file to the index contained in
300300
:sage_root:`src/doc/en/reference/combinat/module_list.rst`.
301301

302-
.. _section-documentation-conditional:
303-
304-
Making portions of the reference manual conditional on optional features
305-
========================================================================
306-
307-
For every dynamically detectable feature such as :class:`graphviz
308-
<~sage.features.graphviz.Graphviz>` or :class:`sage.symbolic
309-
<sage.features.sagemath.sage__symbolic>` (see :mod:`sage.features`),
310-
Sage defines a Sphinx tag that can be used with the `Sphinx
311-
directive ".. ONLY::"
312-
<https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#tags>`_.
313-
Because Sphinx tags have to use Python identifier syntax, Sage uses
314-
the format ``feature_``, followed by the feature name where dots are
315-
replaced by underscores. Hence, conditionalizing on the features of
316-
the previous examples would look as follows:
317-
318-
.. CODE-BLOCK:: rest
319-
320-
.. ONLY:: feature_graphviz
321-
322-
and:
323-
324-
.. CODE-BLOCK:: rest
325-
326-
.. ONLY:: feature_sage_symbolic
327-
328302
.. _section-building-manuals:
329303

330304
Building the manuals

src/doc/en/faq/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,6 @@
1515
from sage_docbuild.conf import release
1616
from sage_docbuild.conf import *
1717

18-
19-
for tag in feature_tags():
20-
tags.add(tag)
21-
22-
2318
# Add any paths that contain custom static files (such as style sheets),
2419
# relative to this directory to html_static_path. They are copied after the
2520
# builtin static files, so a file named "default.css" will overwrite the

src/doc/en/installation/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@
1313
from sage_docbuild.conf import release
1414
from sage_docbuild.conf import * # NOQA
1515

16-
17-
for tag in feature_tags():
18-
tags.add(tag)
19-
20-
2116
# Add any paths that contain custom static files (such as style sheets),
2217
# relative to this directory to html_static_path. They are copied after the
2318
# builtin static files, so a file named "default.css" will overwrite the

src/doc/en/prep/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@
1313
from sage_docbuild.conf import release
1414
from sage_docbuild.conf import * # NOQA
1515

16-
17-
for tag in feature_tags():
18-
tags.add(tag)
19-
20-
2116
# Add any paths that contain custom static files (such as style sheets),
2217
# relative to this directory to html_static_path. They are copied after the
2318
# builtin static files, so a file named "default.css" will overwrite the

src/doc/en/reference/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,6 @@
1515
from sage_docbuild.conf import release, latex_elements, exclude_patterns
1616
from sage_docbuild.conf import *
1717

18-
19-
for tag in feature_tags():
20-
tags.add(tag)
21-
22-
2318
# Add any paths that contain custom static files (such as style sheets),
2419
# relative to this directory to html_static_path. They are copied after the
2520
# builtin static files, so a file named "default.css" will overwrite the

src/doc/en/reference/conf_sub.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,6 @@
1515
from sage_docbuild.conf import release, exclude_patterns
1616
from sage_docbuild.conf import *
1717

18-
19-
for tag in feature_tags():
20-
tags.add(tag)
21-
22-
2318
# Add any paths that contain custom static files (such as style sheets),
2419
# relative to this directory to html_static_path. They are copied after the
2520
# builtin static files, so a file named "default.css" will overwrite the

src/doc/en/reference/polynomial_rings/index.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,9 @@ Tropical Polynomials
7575
Boolean Polynomials
7676
-------------------
7777

78-
.. ONLY:: feature_sage_rings_polynomial_pbori
79-
80-
.. toctree::
81-
:maxdepth: 1
78+
.. toctree::
79+
:maxdepth: 1
8280

83-
sage/rings/polynomial/pbori/pbori
81+
sage/rings/polynomial/pbori/pbori
8482

8583
.. include:: ../footer.txt

src/doc/en/thematic_tutorials/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,6 @@
1515
from sage_docbuild.conf import release
1616
from sage_docbuild.conf import *
1717

18-
19-
for tag in feature_tags():
20-
tags.add(tag)
21-
22-
2318
# Add any paths that contain custom static files (such as style sheets),
2419
# relative to this directory to html_static_path. They are copied after the
2520
# builtin static files, so a file named "default.css" will overwrite the

src/doc/en/thematic_tutorials/explicit_methods_in_number_theory/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@
1313
from sage_docbuild.conf import release
1414
from sage_docbuild.conf import * # NOQA
1515

16-
17-
for tag in feature_tags():
18-
tags.add(tag)
19-
20-
2116
# Add any paths that contain custom static files (such as style sheets),
2217
# relative to this directory to html_static_path. They are copied after the
2318
# builtin static files, so a file named "default.css" will overwrite the

src/doc/en/thematic_tutorials/numerical_sage/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@
1313
from sage_docbuild.conf import release
1414
from sage_docbuild.conf import * # NOQA
1515

16-
17-
for tag in feature_tags():
18-
tags.add(tag)
19-
20-
2116
# Add any paths that contain custom static files (such as style sheets),
2217
# relative to this directory to html_static_path. They are copied after the
2318
# builtin static files, so a file named "default.css" will overwrite the

src/doc/en/tutorial/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@
1313
from sage_docbuild.conf import release
1414
from sage_docbuild.conf import * # NOQA
1515

16-
17-
for tag in feature_tags():
18-
tags.add(tag)
19-
20-
2116
# Add any paths that contain custom static files (such as style sheets),
2217
# relative to this directory to html_static_path. They are copied after the
2318
# builtin static files, so a file named "default.css" will overwrite the

src/doc/en/tutorial/latex.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ output of the entered commands automatically. You can start this
4949
automatic rendering by executing ``%display latex`` (and stop by executing
5050
``%display plain``).
5151

52-
.. ONLY:: html and feature_jupyter_sphinx
52+
.. ONLY:: html
5353

5454
Thus, in the Jupyter notebook, you get
5555

src/doc/en/website/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@
1313
from sage_docbuild.conf import release
1414
from sage_docbuild.conf import * # NOQA
1515

16-
17-
for tag in feature_tags():
18-
tags.add(tag)
19-
20-
2116
# Add any paths that contain custom static files (such as style sheets),
2217
# relative to this directory to html_static_path. They are copied after the
2318
# builtin static files, so a file named "default.css" will overwrite the

src/doc/es/a_tour_of_sage/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,6 @@
1515
from sage_docbuild.conf import release
1616
from sage_docbuild.conf import *
1717

18-
19-
for tag in feature_tags():
20-
tags.add(tag)
21-
22-
2318
# Add any paths that contain custom static files (such as style sheets),
2419
# relative to this directory to html_static_path. They are copied after the
2520
# builtin static files, so a file named "default.css" will overwrite the

src/doc/es/tutorial/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@
1313
from sage_docbuild.conf import release
1414
from sage_docbuild.conf import *
1515

16-
17-
for tag in feature_tags():
18-
tags.add(tag)
19-
20-
2116
# Add any paths that contain custom static files (such as style sheets),
2217
# relative to this directory to html_static_path. They are copied after the
2318
# builtin static files, so a file named "default.css" will overwrite the

src/doc/fr/a_tour_of_sage/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@
1313
from sage_docbuild.conf import release, latex_elements
1414
from sage_docbuild.conf import * # NOQA
1515

16-
17-
for tag in feature_tags():
18-
tags.add(tag)
19-
20-
2116
# Add any paths that contain custom static files (such as style sheets),
2217
# relative to this directory to html_static_path. They are copied after the
2318
# builtin static files, so a file named "default.css" will overwrite the

src/doc/fr/tutorial/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@
1313
from sage_docbuild.conf import release, latex_elements
1414
from sage_docbuild.conf import * # NOQA
1515

16-
17-
for tag in feature_tags():
18-
tags.add(tag)
19-
20-
2116
# Add any paths that contain custom static files (such as style sheets),
2217
# relative to this directory to html_static_path. They are copied after the
2318
# builtin static files, so a file named "default.css" will overwrite the

src/doc/hu/a_tour_of_sage/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,6 @@
1515
from sage_docbuild.conf import release
1616
from sage_docbuild.conf import * # NOQA
1717

18-
19-
for tag in feature_tags():
20-
tags.add(tag)
21-
22-
2318
# Add any paths that contain custom static files (such as style sheets),
2419
# relative to this directory to html_static_path. They are copied after the
2520
# builtin static files, so a file named "default.css" will overwrite the

src/doc/it/a_tour_of_sage/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@
1313
from sage_docbuild.conf import release, latex_elements
1414
from sage_docbuild.conf import * # NOQA
1515

16-
17-
for tag in feature_tags():
18-
tags.add(tag)
19-
20-
2116
# Add any paths that contain custom static files (such as style sheets),
2217
# relative to this directory to html_static_path. They are copied after the
2318
# builtin static files, so a file named "default.css" will overwrite the

src/doc/it/faq/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,6 @@
1515
from sage_docbuild.conf import release
1616
from sage_docbuild.conf import *
1717

18-
19-
for tag in feature_tags():
20-
tags.add(tag)
21-
22-
2318
# Add any paths that contain custom static files (such as style sheets),
2419
# relative to this directory to html_static_path. They are copied after the
2520
# builtin static files, so a file named "default.css" will overwrite the

src/doc/it/tutorial/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@
1313
from sage_docbuild.conf import release, latex_elements
1414
from sage_docbuild.conf import * # NOQA
1515

16-
17-
for tag in feature_tags():
18-
tags.add(tag)
19-
20-
2116
# Add any paths that contain custom static files (such as style sheets),
2217
# relative to this directory to html_static_path. They are copied after the
2318
# builtin static files, so a file named "default.css" will overwrite the

src/doc/ja/a_tour_of_sage/conf.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@
1313
from sage_docbuild.conf import release, latex_elements
1414
from sage_docbuild.conf import * # NOQA
1515

16-
17-
for tag in feature_tags():
18-
tags.add(tag)
19-
20-
2116
# Add any paths that contain custom static files (such as style sheets),
2217
# relative to this directory to html_static_path. They are copied after the
2318
# builtin static files, so a file named "default.css" will overwrite the

0 commit comments

Comments
 (0)