Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make doc-pdf separate from doc-html #36692

Merged
merged 5 commits into from
Nov 14, 2023
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
14 changes: 7 additions & 7 deletions src/doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,17 @@ doc-inventory-reference: doc-src
$(MAKE) SAGE_DOCBUILD_OPTS="$(SAGE_DOCBUILD_OPTS) --no-prune-empty-dirs" doc-inventory--reference_top
endif

# reference manual, html
doc-html-reference: doc-inventory-reference
# sub docs of reference manual, html
doc-html-reference-sub: doc-inventory-reference
$(eval DOCS = $(shell sage --docbuild --all-documents reference))
@if [ -z "$(DOCS)" ]; then echo "Error: 'sage --docbuild --all-documents' failed"; exit 1; fi
$(eval BIBLIO = $(firstword $(DOCS)))
$(eval OTHER_DOCS = $(wordlist 2, 100, $(DOCS)))
$(MAKE) SAGE_DOCBUILD_OPTS="$(SAGE_DOCBUILD_OPTS) --no-prune-empty-dirs" doc-html--$(subst /,-,$(BIBLIO))
$(MAKE) SAGE_DOCBUILD_OPTS="$(SAGE_DOCBUILD_OPTS) --no-prune-empty-dirs" $(foreach doc, $(OTHER_DOCS), doc-html--$(subst /,-,$(doc)))

# reference manual, html; reference_top is built after sub docs
doc-html-reference: doc-html-reference-sub
$(MAKE) SAGE_DOCBUILD_OPTS="$(SAGE_DOCBUILD_OPTS) --no-prune-empty-dirs" doc-html--reference_top

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

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

# website with pdf links
doc-pdf-website:
sage --docbuild website html $(SAGE_DOCBUILD_OPTS)
doc-pdf: doc-pdf-reference doc-pdf-other

doc-pdf: doc-pdf-reference doc-pdf-other doc-pdf-website

.PHONY: all clean \
doc-src \
Expand Down
7 changes: 7 additions & 0 deletions src/doc/en/reference/references/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -960,6 +960,13 @@ REFERENCES:
.. [BL2003] \S. Brlek, A. Ladouceur, A note on differentiable palindromes,
Theoret. Comput. Sci. 302 (2003) 167--178.

.. [BLL1998] \F. Bergeron, G. Labelle, and P. Leroux.
"Combinatorial species and tree-like structures".
Encyclopedia of Mathematics and its Applications, vol. 67, Cambridge Univ. Press. 1998.

.. [BLL2008] François Bergeron, Gilbert Labelle, and Pierre Leroux.
"Introduction to the Theory of Species of Structures", March 14, 2008.

.. [BraLea2008] \C. Bracken and Gregor Leander: *New families of functions
with differential uniformity of 4*, Proceedings of the Conference
BFCA, Copenhagen, 2008.
Expand Down
2 changes: 1 addition & 1 deletion src/doc/en/website/root_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ <h1>Sage Documentation</h1>
<div class='entry lang-en'><a href='pdf/en/prep/prep_tutorials.pdf'>PREP Tutorials</a></div>
<div class='entry lang-en'><a href='pdf/en/constructions/constructions.pdf'>Constructions</a></div>
<div class='entry lang-en'><a href='pdf/en/faq/faq.pdf'>FAQ</a></div>
<div class='entry lang-en'><a href='pdf/en/reference/index.html'>Reference Manual</a></div>
<div class='entry lang-en'><a href='html/en/reference/index-pdf.html'>Reference Manual</a></div>
<div class='entry lang-en'><a href='pdf/en/installation/installation.pdf'>Installation Guide</a></div>
<div class='entry lang-en'><a href='pdf/en/developer/developer.pdf'>Developer Guide</a></div>
</div></div>
Expand Down
54 changes: 27 additions & 27 deletions src/doc/en/website/templates/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@ <h2>
<tr valign="top">
<td width="50%">
<p class="biglink">
<a class="biglink" href="a_tour_of_sage/index.html">
A Tour of Sage
</a>
<a title="Download PDF" class="pdf" href="../../pdf/en/a_tour_of_sage/a_tour_of_sage.pdf">
<img class="icon" src="_static/pdf.png"></img>
</a>
<a class="biglink" href="a_tour_of_sage/index.html">
A Tour of Sage
</a>
<br>
<span class="linkdescr">
This is a tour of Sage that closely follows the tour of
Expand All @@ -60,12 +60,12 @@ <h2>
</td>
<td width="50%">
<p class="biglink">
<a class="biglink" href="prep/index.html">
PREP Tutorials
</a>
<a title="Download PDF" class="pdf" href="../../pdf/en/prep/prep_tutorials.pdf">
<img class="icon" src="_static/pdf.png"></img>
</a>
<a class="biglink" href="prep/index.html">
PREP Tutorials
</a>
<br>
<span class="linkdescr">
This set of tutorials takes the reader from very minimal
Expand All @@ -80,12 +80,12 @@ <h2>
<tr valign="top">
<td width="50%">
<p class="biglink">
<a class="biglink" href="tutorial/index.html">
Tutorial
</a>
<a title="Download PDF" class="pdf" href="../../pdf/en/tutorial/sage_tutorial.pdf">
<img class="icon" src="_static/pdf.png"></img>
</a>
<a class="biglink" href="tutorial/index.html">
Tutorial
</a>
<br>
<span class="linkdescr">
This tutorial is the best way to become familiar with Sage
Expand All @@ -95,12 +95,12 @@ <h2>
</td>
<td width="50%">
<p class="biglink">
<a class="biglink" href="constructions/index.html">
Constructions
</a>
<a title="Download PDF" class="pdf" href="../../pdf/en/constructions/constructions.pdf">
<img class="icon" src="_static/pdf.png"></img>
</a>
<a class="biglink" href="constructions/index.html">
Constructions
</a>
<br>
<span class="linkdescr">
This document collects answers to some questions along the line "How
Expand All @@ -113,12 +113,12 @@ <h2>
<tr valign="top">
<td width="50%">
<p class="biglink">
<a class="biglink" href="thematic_tutorials/index.html">
Thematic Tutorials
</a>
<a title="Download PDF" class="pdf" href="../../pdf/en/thematic_tutorials/thematic_tutorials.pdf">
<img class="icon" src="_static/pdf.png"></img>
</a>
<a class="biglink" href="thematic_tutorials/index.html">
Thematic Tutorials
</a>
<br>
<span class="linkdescr">
A collection of in-depth tutorials on specific topics. These
Expand All @@ -133,12 +133,12 @@ <h2>
</td>
<td width="50%">
<p class="biglink">
<a class="biglink" href="faq/index.html">
FAQ
</a>
<a title="Download PDF" class="pdf" href="../../pdf/en/faq/faq.pdf">
<img class="icon" src="_static/pdf.png"></img>
</a>
<a class="biglink" href="faq/index.html">
FAQ
</a>
<br>
<span class="linkdescr">
A collection of frequently asked questions, together with
Expand All @@ -158,12 +158,12 @@ <h2>
<tr valign="top">
<td width="50%">
<p class="biglink">
<a title="Link to PDF" class="pdf" href="reference/index-pdf.html">
<img class="icon" src="_static/pdf.png"></img>
</a>
<a class="biglink" href="reference/index.html">
Reference Manual
</a>
<a title="Link to PDF" class="pdf" href="../../pdf/en/reference/index.html">
<img class="icon" src="_static/pdf.png"></img>
</a>
<br>
<span class="linkdescr">
This is the reference manual for the Sage mathematics
Expand All @@ -189,12 +189,12 @@ <h2>
<tr valign="top">
<td width="50%">
<p class="biglink">
<a class="biglink" href="installation/index.html">
Installation Guide
</a>
<a title="Download PDF" class="pdf" href="../../pdf/en/installation/installation.pdf">
<img class="icon" src="_static/pdf.png"></img>
</a>
<a class="biglink" href="installation/index.html">
Installation Guide
</a>
<br>
<span class="linkdescr">
A guide on how to install Sage. You can install a Sage
Expand All @@ -206,12 +206,12 @@ <h2>
</td>
<td width="50%">
<p class="biglink">
<a class="biglink" href="developer/index.html">
Developer Guide
</a>
<a title="Download PDF" class="pdf" href="../../pdf/en/developer/developer.pdf">
<img class="icon" src="_static/pdf.png"></img>
</a>
<a class="biglink" href="developer/index.html">
Developer Guide
</a>
<br>
<span class="linkdescr">
This document describes guidelines and policies regarding
Expand Down
54 changes: 27 additions & 27 deletions src/doc/en/website/templates/index_furo.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,12 @@ <h2>
<tr valign="top">
<td width="50%">
<p class="biglink">
<a class="biglink" href="a_tour_of_sage/index.html">
A Tour of Sage
</a>
<a title="Download PDF" class="pdf" href="../../pdf/en/a_tour_of_sage/a_tour_of_sage.pdf">
<img class="icon" src="_static/pdf.png"></img>
</a>
<a class="biglink" href="a_tour_of_sage/index.html">
A Tour of Sage
</a>
<br>
<span class="linkdescr">
A one page introduction to Sage as a handy calculator.
Expand All @@ -55,12 +55,12 @@ <h2>
</td>
<td width="50%">
<p class="biglink">
<a class="biglink" href="prep/index.html">
PREP Tutorials
</a>
<a title="Download PDF" class="pdf" href="../../pdf/en/prep/prep_tutorials.pdf">
<img class="icon" src="_static/pdf.png"></img>
</a>
<a class="biglink" href="prep/index.html">
PREP Tutorials
</a>
<br>
<span class="linkdescr">
This set of tutorials takes the reader from very minimal
Expand All @@ -75,12 +75,12 @@ <h2>
<tr valign="top">
<td width="50%">
<p class="biglink">
<a class="biglink" href="tutorial/index.html">
Tutorial
</a>
<a title="Download PDF" class="pdf" href="../../pdf/en/tutorial/sage_tutorial.pdf">
<img class="icon" src="_static/pdf.png"></img>
</a>
<a class="biglink" href="tutorial/index.html">
Tutorial
</a>
<br>
<span class="linkdescr">
The best way to become familiar with Sage
Expand All @@ -90,12 +90,12 @@ <h2>
</td>
<td width="50%">
<p class="biglink">
<a class="biglink" href="constructions/index.html">
Constructions
</a>
<a title="Download PDF" class="pdf" href="../../pdf/en/constructions/constructions.pdf">
<img class="icon" src="_static/pdf.png"></img>
</a>
<a class="biglink" href="constructions/index.html">
Constructions
</a>
<br>
<span class="linkdescr">
This document collects answers to some questions along the line "How
Expand All @@ -108,12 +108,12 @@ <h2>
<tr valign="top">
<td width="50%">
<p class="biglink">
<a class="biglink" href="thematic_tutorials/index.html">
Thematic Tutorials
</a>
<a title="Download PDF" class="pdf" href="../../pdf/en/thematic_tutorials/thematic_tutorials.pdf">
<img class="icon" src="_static/pdf.png"></img>
</a>
<a class="biglink" href="thematic_tutorials/index.html">
Thematic Tutorials
</a>
<br>
<span class="linkdescr">
A collection of in-depth tutorials on specific topics. These
Expand All @@ -128,12 +128,12 @@ <h2>
</td>
<td width="50%">
<p class="biglink">
<a class="biglink" href="faq/index.html">
FAQ
</a>
<a title="Download PDF" class="pdf" href="../../pdf/en/faq/faq.pdf">
<img class="icon" src="_static/pdf.png"></img>
</a>
<a class="biglink" href="faq/index.html">
FAQ
</a>
<br>
<span class="linkdescr">
A collection of frequently asked questions, together with
Expand All @@ -153,12 +153,12 @@ <h2>
<tr valign="top">
<td width="50%">
<p class="biglink">
<a title="Link to PDF" class="pdf" href="reference/index-pdf.html">
<img class="icon" src="_static/pdf.png"></img>
</a>
<a class="biglink" href="reference/index.html">
Reference Manual
</a>
<a title="Link to PDF" class="pdf" href="../../pdf/en/reference/index.html">
<img class="icon" src="_static/pdf.png"></img>
</a>
<br>
<span class="linkdescr">
This is the reference manual for the Sage mathematics
Expand All @@ -184,12 +184,12 @@ <h2>
<tr valign="top">
<td width="50%">
<p class="biglink">
<a class="biglink" href="installation/index.html">
Installation Guide
</a>
<a title="Download PDF" class="pdf" href="../../pdf/en/installation/installation.pdf">
<img class="icon" src="_static/pdf.png"></img>
</a>
<a class="biglink" href="installation/index.html">
Installation Guide
</a>
<br>
<span class="linkdescr">
A guide on how to install Sage. You can install a Sage
Expand All @@ -201,12 +201,12 @@ <h2>
</td>
<td width="50%">
<p class="biglink">
<a class="biglink" href="developer/index.html">
Developer Guide
</a>
<a title="Download PDF" class="pdf" href="../../pdf/en/developer/developer.pdf">
<img class="icon" src="_static/pdf.png"></img>
</a>
<a class="biglink" href="developer/index.html">
Developer Guide
</a>
<br>
<span class="linkdescr">
This document describes guidelines and policies regarding
Expand Down
11 changes: 2 additions & 9 deletions src/sage/combinat/species/generating_series.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,6 @@
sage: s[3] # optional - sage.modules
p[1, 1, 1] + p[2, 1]

REFERENCES:

.. [BLL] \F. Bergeron, G. Labelle, and P. Leroux.
"Combinatorial species and tree-like structures".
Encyclopedia of Mathematics and its Applications, vol. 67, Cambridge Univ. Press. 1998.
.. [BLL-Intro] François Bergeron, Gilbert Labelle, and Pierre Leroux.
"Introduction to the Theory of Species of Structures", March 14, 2008.
"""

# ****************************************************************************
Expand Down Expand Up @@ -217,7 +210,7 @@ def functorial_composition(self, y):

REFERENCES:

- Section 2.2 of [BLL]_.
- Section 2.2 of [BLL1998]_.

EXAMPLES::

Expand Down Expand Up @@ -651,7 +644,7 @@ def LogarithmCycleIndexSeries(R=QQ):
Return the cycle index series of the virtual species `\Omega`, the
compositional inverse of the species `E^{+}` of nonempty sets.

The notion of virtual species is treated thoroughly in [BLL]_.
The notion of virtual species is treated thoroughly in [BLL1998]_.
The specific algorithm used here to compute the cycle index of
`\Omega` is found in [Labelle2008]_.

Expand Down
2 changes: 1 addition & 1 deletion src/sage/rings/lazy_series.py
Original file line number Diff line number Diff line change
Expand Up @@ -6219,7 +6219,7 @@ def functorial_composition(self, *args):
whose labels are the set of all `G`-structures on `A`.

The Frobenius character (or cycle index series) of `F \Box G`
can be computed as follows, see section 2.2 of [BLL]_):
can be computed as follows, see section 2.2 of [BLL1998]_):

.. MATH::

Expand Down
Loading