Skip to content

Commit 613775f

Browse files
author
Release Manager
committed
gh-36692: Make doc-pdf separate from doc-html <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes #1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> (1) Fixes the issue in #36614 (comment) by making doc-pdf target separate from doc-html target. (2) Support `.. ONLY::` (introduced by #36495) in generating rst files for sage modules by the reference builder. (3) Edited the pdf docs website to look consistent and tidy. <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes #12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - #12345: short description why this is a dependency - #34567: ... --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: #36692 Reported by: Kwankyu Lee Reviewer(s): Matthias Köppe
2 parents 606c816 + afb9964 commit 613775f

File tree

9 files changed

+132
-102
lines changed

9 files changed

+132
-102
lines changed

‎src/doc/Makefile‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,17 @@ doc-inventory-reference: doc-src
4646
$(MAKE) SAGE_DOCBUILD_OPTS="$(SAGE_DOCBUILD_OPTS) --no-prune-empty-dirs" doc-inventory--reference_top
4747
endif
4848

49-
# reference manual, html
50-
doc-html-reference: doc-inventory-reference
49+
# sub docs of reference manual, html
50+
doc-html-reference-sub: doc-inventory-reference
5151
$(eval DOCS = $(shell sage --docbuild --all-documents reference))
5252
@if [ -z "$(DOCS)" ]; then echo "Error: 'sage --docbuild --all-documents' failed"; exit 1; fi
5353
$(eval BIBLIO = $(firstword $(DOCS)))
5454
$(eval OTHER_DOCS = $(wordlist 2, 100, $(DOCS)))
5555
$(MAKE) SAGE_DOCBUILD_OPTS="$(SAGE_DOCBUILD_OPTS) --no-prune-empty-dirs" doc-html--$(subst /,-,$(BIBLIO))
5656
$(MAKE) SAGE_DOCBUILD_OPTS="$(SAGE_DOCBUILD_OPTS) --no-prune-empty-dirs" $(foreach doc, $(OTHER_DOCS), doc-html--$(subst /,-,$(doc)))
57+
58+
# reference manual, html; reference_top is built after sub docs
59+
doc-html-reference: doc-html-reference-sub
5760
$(MAKE) SAGE_DOCBUILD_OPTS="$(SAGE_DOCBUILD_OPTS) --no-prune-empty-dirs" doc-html--reference_top
5861

5962
# other documentation, html
@@ -79,16 +82,13 @@ doc-pdf-reference: doc-inventory-reference
7982
$(MAKE) SAGE_DOCBUILD_OPTS="$(SAGE_DOCBUILD_OPTS) --no-prune-empty-dirs" doc-pdf--reference_top
8083

8184
# other documentation, pdf
82-
doc-pdf-other: doc-html-reference
85+
doc-pdf-other: doc-pdf-reference
8386
$(eval DOCS = $(shell sage --docbuild --all-documents all))
8487
@if [ -z "$(DOCS)" ]; then echo "Error: 'sage --docbuild --all-documents' failed"; exit 1; fi
8588
$(MAKE) SAGE_DOCBUILD_OPTS="$(SAGE_DOCBUILD_OPTS) --no-prune-empty-dirs" $(foreach doc, $(wordlist 2, 100, $(DOCS)), doc-pdf--$(subst /,-,$(doc)))
8689

87-
# website with pdf links
88-
doc-pdf-website:
89-
sage --docbuild website html $(SAGE_DOCBUILD_OPTS)
90+
doc-pdf: doc-pdf-reference doc-pdf-other
9091

91-
doc-pdf: doc-pdf-reference doc-pdf-other doc-pdf-website
9292

9393
.PHONY: all clean \
9494
doc-src \

‎src/doc/en/reference/references/index.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -960,6 +960,13 @@ REFERENCES:
960960
.. [BL2003] \S. Brlek, A. Ladouceur, A note on differentiable palindromes,
961961
Theoret. Comput. Sci. 302 (2003) 167--178.
962962
963+
.. [BLL1998] \F. Bergeron, G. Labelle, and P. Leroux.
964+
"Combinatorial species and tree-like structures".
965+
Encyclopedia of Mathematics and its Applications, vol. 67, Cambridge Univ. Press. 1998.
966+
967+
.. [BLL2008] François Bergeron, Gilbert Labelle, and Pierre Leroux.
968+
"Introduction to the Theory of Species of Structures", March 14, 2008.
969+
963970
.. [BraLea2008] \C. Bracken and Gregor Leander: *New families of functions
964971
with differential uniformity of 4*, Proceedings of the Conference
965972
BFCA, Copenhagen, 2008.

‎src/doc/en/website/root_index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ <h1>Sage Documentation</h1>
118118
<div class='entry lang-en'><a href='pdf/en/prep/prep_tutorials.pdf'>PREP Tutorials</a></div>
119119
<div class='entry lang-en'><a href='pdf/en/constructions/constructions.pdf'>Constructions</a></div>
120120
<div class='entry lang-en'><a href='pdf/en/faq/faq.pdf'>FAQ</a></div>
121-
<div class='entry lang-en'><a href='pdf/en/reference/index.html'>Reference Manual</a></div>
121+
<div class='entry lang-en'><a href='html/en/reference/index-pdf.html'>Reference Manual</a></div>
122122
<div class='entry lang-en'><a href='pdf/en/installation/installation.pdf'>Installation Guide</a></div>
123123
<div class='entry lang-en'><a href='pdf/en/developer/developer.pdf'>Developer Guide</a></div>
124124
</div></div>

‎src/doc/en/website/templates/index.html‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,12 @@ <h2>
4444
<tr valign="top">
4545
<td width="50%">
4646
<p class="biglink">
47-
<a class="biglink" href="a_tour_of_sage/index.html">
48-
A Tour of Sage
49-
</a>
5047
<a title="Download PDF" class="pdf" href="../../pdf/en/a_tour_of_sage/a_tour_of_sage.pdf">
5148
<img class="icon" src="_static/pdf.png"></img>
5249
</a>
50+
<a class="biglink" href="a_tour_of_sage/index.html">
51+
A Tour of Sage
52+
</a>
5353
<br>
5454
<span class="linkdescr">
5555
This is a tour of Sage that closely follows the tour of
@@ -60,12 +60,12 @@ <h2>
6060
</td>
6161
<td width="50%">
6262
<p class="biglink">
63-
<a class="biglink" href="prep/index.html">
64-
PREP Tutorials
65-
</a>
6663
<a title="Download PDF" class="pdf" href="../../pdf/en/prep/prep_tutorials.pdf">
6764
<img class="icon" src="_static/pdf.png"></img>
6865
</a>
66+
<a class="biglink" href="prep/index.html">
67+
PREP Tutorials
68+
</a>
6969
<br>
7070
<span class="linkdescr">
7171
This set of tutorials takes the reader from very minimal
@@ -80,12 +80,12 @@ <h2>
8080
<tr valign="top">
8181
<td width="50%">
8282
<p class="biglink">
83-
<a class="biglink" href="tutorial/index.html">
84-
Tutorial
85-
</a>
8683
<a title="Download PDF" class="pdf" href="../../pdf/en/tutorial/sage_tutorial.pdf">
8784
<img class="icon" src="_static/pdf.png"></img>
8885
</a>
86+
<a class="biglink" href="tutorial/index.html">
87+
Tutorial
88+
</a>
8989
<br>
9090
<span class="linkdescr">
9191
This tutorial is the best way to become familiar with Sage
@@ -95,12 +95,12 @@ <h2>
9595
</td>
9696
<td width="50%">
9797
<p class="biglink">
98-
<a class="biglink" href="constructions/index.html">
99-
Constructions
100-
</a>
10198
<a title="Download PDF" class="pdf" href="../../pdf/en/constructions/constructions.pdf">
10299
<img class="icon" src="_static/pdf.png"></img>
103100
</a>
101+
<a class="biglink" href="constructions/index.html">
102+
Constructions
103+
</a>
104104
<br>
105105
<span class="linkdescr">
106106
This document collects answers to some questions along the line "How
@@ -113,12 +113,12 @@ <h2>
113113
<tr valign="top">
114114
<td width="50%">
115115
<p class="biglink">
116-
<a class="biglink" href="thematic_tutorials/index.html">
117-
Thematic Tutorials
118-
</a>
119116
<a title="Download PDF" class="pdf" href="../../pdf/en/thematic_tutorials/thematic_tutorials.pdf">
120117
<img class="icon" src="_static/pdf.png"></img>
121118
</a>
119+
<a class="biglink" href="thematic_tutorials/index.html">
120+
Thematic Tutorials
121+
</a>
122122
<br>
123123
<span class="linkdescr">
124124
A collection of in-depth tutorials on specific topics. These
@@ -133,12 +133,12 @@ <h2>
133133
</td>
134134
<td width="50%">
135135
<p class="biglink">
136-
<a class="biglink" href="faq/index.html">
137-
FAQ
138-
</a>
139136
<a title="Download PDF" class="pdf" href="../../pdf/en/faq/faq.pdf">
140137
<img class="icon" src="_static/pdf.png"></img>
141138
</a>
139+
<a class="biglink" href="faq/index.html">
140+
FAQ
141+
</a>
142142
<br>
143143
<span class="linkdescr">
144144
A collection of frequently asked questions, together with
@@ -158,12 +158,12 @@ <h2>
158158
<tr valign="top">
159159
<td width="50%">
160160
<p class="biglink">
161+
<a title="Link to PDF" class="pdf" href="reference/index-pdf.html">
162+
<img class="icon" src="_static/pdf.png"></img>
163+
</a>
161164
<a class="biglink" href="reference/index.html">
162165
Reference Manual
163166
</a>
164-
<a title="Link to PDF" class="pdf" href="../../pdf/en/reference/index.html">
165-
<img class="icon" src="_static/pdf.png"></img>
166-
</a>
167167
<br>
168168
<span class="linkdescr">
169169
This is the reference manual for the Sage mathematics
@@ -189,12 +189,12 @@ <h2>
189189
<tr valign="top">
190190
<td width="50%">
191191
<p class="biglink">
192-
<a class="biglink" href="installation/index.html">
193-
Installation Guide
194-
</a>
195192
<a title="Download PDF" class="pdf" href="../../pdf/en/installation/installation.pdf">
196193
<img class="icon" src="_static/pdf.png"></img>
197194
</a>
195+
<a class="biglink" href="installation/index.html">
196+
Installation Guide
197+
</a>
198198
<br>
199199
<span class="linkdescr">
200200
A guide on how to install Sage. You can install a Sage
@@ -206,12 +206,12 @@ <h2>
206206
</td>
207207
<td width="50%">
208208
<p class="biglink">
209-
<a class="biglink" href="developer/index.html">
210-
Developer Guide
211-
</a>
212209
<a title="Download PDF" class="pdf" href="../../pdf/en/developer/developer.pdf">
213210
<img class="icon" src="_static/pdf.png"></img>
214211
</a>
212+
<a class="biglink" href="developer/index.html">
213+
Developer Guide
214+
</a>
215215
<br>
216216
<span class="linkdescr">
217217
This document describes guidelines and policies regarding

‎src/doc/en/website/templates/index_furo.html‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,12 @@ <h2>
4141
<tr valign="top">
4242
<td width="50%">
4343
<p class="biglink">
44-
<a class="biglink" href="a_tour_of_sage/index.html">
45-
A Tour of Sage
46-
</a>
4744
<a title="Download PDF" class="pdf" href="../../pdf/en/a_tour_of_sage/a_tour_of_sage.pdf">
4845
<img class="icon" src="_static/pdf.png"></img>
4946
</a>
47+
<a class="biglink" href="a_tour_of_sage/index.html">
48+
A Tour of Sage
49+
</a>
5050
<br>
5151
<span class="linkdescr">
5252
A one page introduction to Sage as a handy calculator.
@@ -55,12 +55,12 @@ <h2>
5555
</td>
5656
<td width="50%">
5757
<p class="biglink">
58-
<a class="biglink" href="prep/index.html">
59-
PREP Tutorials
60-
</a>
6158
<a title="Download PDF" class="pdf" href="../../pdf/en/prep/prep_tutorials.pdf">
6259
<img class="icon" src="_static/pdf.png"></img>
6360
</a>
61+
<a class="biglink" href="prep/index.html">
62+
PREP Tutorials
63+
</a>
6464
<br>
6565
<span class="linkdescr">
6666
This set of tutorials takes the reader from very minimal
@@ -75,12 +75,12 @@ <h2>
7575
<tr valign="top">
7676
<td width="50%">
7777
<p class="biglink">
78-
<a class="biglink" href="tutorial/index.html">
79-
Tutorial
80-
</a>
8178
<a title="Download PDF" class="pdf" href="../../pdf/en/tutorial/sage_tutorial.pdf">
8279
<img class="icon" src="_static/pdf.png"></img>
8380
</a>
81+
<a class="biglink" href="tutorial/index.html">
82+
Tutorial
83+
</a>
8484
<br>
8585
<span class="linkdescr">
8686
The best way to become familiar with Sage
@@ -90,12 +90,12 @@ <h2>
9090
</td>
9191
<td width="50%">
9292
<p class="biglink">
93-
<a class="biglink" href="constructions/index.html">
94-
Constructions
95-
</a>
9693
<a title="Download PDF" class="pdf" href="../../pdf/en/constructions/constructions.pdf">
9794
<img class="icon" src="_static/pdf.png"></img>
9895
</a>
96+
<a class="biglink" href="constructions/index.html">
97+
Constructions
98+
</a>
9999
<br>
100100
<span class="linkdescr">
101101
This document collects answers to some questions along the line "How
@@ -108,12 +108,12 @@ <h2>
108108
<tr valign="top">
109109
<td width="50%">
110110
<p class="biglink">
111-
<a class="biglink" href="thematic_tutorials/index.html">
112-
Thematic Tutorials
113-
</a>
114111
<a title="Download PDF" class="pdf" href="../../pdf/en/thematic_tutorials/thematic_tutorials.pdf">
115112
<img class="icon" src="_static/pdf.png"></img>
116113
</a>
114+
<a class="biglink" href="thematic_tutorials/index.html">
115+
Thematic Tutorials
116+
</a>
117117
<br>
118118
<span class="linkdescr">
119119
A collection of in-depth tutorials on specific topics. These
@@ -128,12 +128,12 @@ <h2>
128128
</td>
129129
<td width="50%">
130130
<p class="biglink">
131-
<a class="biglink" href="faq/index.html">
132-
FAQ
133-
</a>
134131
<a title="Download PDF" class="pdf" href="../../pdf/en/faq/faq.pdf">
135132
<img class="icon" src="_static/pdf.png"></img>
136133
</a>
134+
<a class="biglink" href="faq/index.html">
135+
FAQ
136+
</a>
137137
<br>
138138
<span class="linkdescr">
139139
A collection of frequently asked questions, together with
@@ -153,12 +153,12 @@ <h2>
153153
<tr valign="top">
154154
<td width="50%">
155155
<p class="biglink">
156+
<a title="Link to PDF" class="pdf" href="reference/index-pdf.html">
157+
<img class="icon" src="_static/pdf.png"></img>
158+
</a>
156159
<a class="biglink" href="reference/index.html">
157160
Reference Manual
158161
</a>
159-
<a title="Link to PDF" class="pdf" href="../../pdf/en/reference/index.html">
160-
<img class="icon" src="_static/pdf.png"></img>
161-
</a>
162162
<br>
163163
<span class="linkdescr">
164164
This is the reference manual for the Sage mathematics
@@ -184,12 +184,12 @@ <h2>
184184
<tr valign="top">
185185
<td width="50%">
186186
<p class="biglink">
187-
<a class="biglink" href="installation/index.html">
188-
Installation Guide
189-
</a>
190187
<a title="Download PDF" class="pdf" href="../../pdf/en/installation/installation.pdf">
191188
<img class="icon" src="_static/pdf.png"></img>
192189
</a>
190+
<a class="biglink" href="installation/index.html">
191+
Installation Guide
192+
</a>
193193
<br>
194194
<span class="linkdescr">
195195
A guide on how to install Sage. You can install a Sage
@@ -201,12 +201,12 @@ <h2>
201201
</td>
202202
<td width="50%">
203203
<p class="biglink">
204-
<a class="biglink" href="developer/index.html">
205-
Developer Guide
206-
</a>
207204
<a title="Download PDF" class="pdf" href="../../pdf/en/developer/developer.pdf">
208205
<img class="icon" src="_static/pdf.png"></img>
209206
</a>
207+
<a class="biglink" href="developer/index.html">
208+
Developer Guide
209+
</a>
210210
<br>
211211
<span class="linkdescr">
212212
This document describes guidelines and policies regarding

‎src/sage/combinat/species/generating_series.py‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,6 @@
3030
sage: s[3] # optional - sage.modules
3131
p[1, 1, 1] + p[2, 1]
3232
33-
REFERENCES:
34-
35-
.. [BLL] \F. Bergeron, G. Labelle, and P. Leroux.
36-
"Combinatorial species and tree-like structures".
37-
Encyclopedia of Mathematics and its Applications, vol. 67, Cambridge Univ. Press. 1998.
38-
.. [BLL-Intro] François Bergeron, Gilbert Labelle, and Pierre Leroux.
39-
"Introduction to the Theory of Species of Structures", March 14, 2008.
4033
"""
4134

4235
# ****************************************************************************
@@ -217,7 +210,7 @@ def functorial_composition(self, y):
217210
218211
REFERENCES:
219212
220-
- Section 2.2 of [BLL]_.
213+
- Section 2.2 of [BLL1998]_.
221214
222215
EXAMPLES::
223216
@@ -651,7 +644,7 @@ def LogarithmCycleIndexSeries(R=QQ):
651644
Return the cycle index series of the virtual species `\Omega`, the
652645
compositional inverse of the species `E^{+}` of nonempty sets.
653646
654-
The notion of virtual species is treated thoroughly in [BLL]_.
647+
The notion of virtual species is treated thoroughly in [BLL1998]_.
655648
The specific algorithm used here to compute the cycle index of
656649
`\Omega` is found in [Labelle2008]_.
657650

‎src/sage/rings/lazy_series.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6219,7 +6219,7 @@ def functorial_composition(self, *args):
62196219
whose labels are the set of all `G`-structures on `A`.
62206220
62216221
The Frobenius character (or cycle index series) of `F \Box G`
6222-
can be computed as follows, see section 2.2 of [BLL]_):
6222+
can be computed as follows, see section 2.2 of [BLL1998]_):
62236223
62246224
.. MATH::
62256225

0 commit comments

Comments
 (0)