Skip to content

Install built doc to SAGE_DOC #40807

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.

Sign up for GitHub

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

Open
kwankyu wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Install built doc to SAGE_DOC #40807

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
db97e16
Install built doc to SAGE_DOC
kwankyu Sep 12, 2025
4da57d0
Print the doc install directory only for make
kwankyu Sep 15, 2025
aed9e8b
Make links instead of copying
kwankyu Dec 1, 2025
54c2eff
Add -F flag
kwankyu Dec 2, 2025
ca27ce3
Merge branch 'develop' into p/fix-doc-location
kwankyu Dec 2, 2025
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
11 changes: 9 additions & 2 deletions src/doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,25 @@
all: doc-html

clean:
rm -rf "$(SAGE_ROOT)/build/sage-distro/src/doc"
# and a few more things that were previously generated
rm -rf en/reference/*/sage
rm -rf en/reference/documentation/sage_docbuild
rm -rf en/reference/sage
rm -f common/*.pyc
# clean the meson build directory
rm -rf ../../build/sage-distro/src/doc

doc-html:
meson compile -C ../../build/sage-distro doc-html
mkdir -p $(SAGE_DOC)
ln -sF ../../../../build/sage-distro/src/doc/html $(SAGE_DOC)/html
ln -sF ../../../../build/sage-distro/src/doc/index.html $(SAGE_DOC)/index.html
@echo "The html documentation was installed to $(SAGE_DOC)/html."

doc-pdf:
meson compile -C ../../build/sage-distro doc-pdf
mkdir -p $(SAGE_DOC)
ln -sF ../../../../build/sage-distro/src/doc/pdf $(SAGE_DOC)/pdf
@echo "The pdf documentation was installed to $(SAGE_DOC)/pdf."

.PHONY: all clean \
doc-src \
Expand Down
2 changes: 1 addition & 1 deletion src/sage_docbuild/builders.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,10 +181,10 @@

EXAMPLES::

sage: from sage_docbuild.builders import DocBuilder

Check failure on line 184 in src/sage_docbuild/builders.py

View workflow job for this annotation

GitHub Actions / Conda (ubuntu, Python 3.12, new)

Failed example: 

Failed example:: Exception raised:
Traceback (most recent call last):
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 734, in _run
    self.compile_and_execute(example, compiler, test.globs)
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 1158, in compile_and_execute
    exec(compiled, globs)
  File "<doctest sage_docbuild.builders.DocBuilder._output_dir[0]>", line 1, in <module>
    from sage_docbuild.builders import DocBuilder
ModuleNotFoundError: No module named 'sage_docbuild'
sage: from sage_docbuild.build_options import BuildOptions

Check failure on line 185 in src/sage_docbuild/builders.py

View workflow job for this annotation

GitHub Actions / Conda (ubuntu, Python 3.12, new)

Failed example: 

Failed example:: Exception raised:
Traceback (most recent call last):
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 734, in _run
    self.compile_and_execute(example, compiler, test.globs)
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 1158, in compile_and_execute
    exec(compiled, globs)
  File "<doctest sage_docbuild.builders.DocBuilder._output_dir[1]>", line 1, in <module>
    from sage_docbuild.build_options import BuildOptions
ModuleNotFoundError: No module named 'sage_docbuild'
sage: import tempfile
sage: with tempfile.TemporaryDirectory() as directory:

Check failure on line 187 in src/sage_docbuild/builders.py

View workflow job for this annotation

GitHub Actions / Conda (ubuntu, Python 3.12, new)

Failed example: 

Failed example:: Exception raised:
Traceback (most recent call last):
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 734, in _run
    self.compile_and_execute(example, compiler, test.globs)
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 1158, in compile_and_execute
    exec(compiled, globs)
  File "<doctest sage_docbuild.builders.DocBuilder._output_dir[3]>", line 2, in <module>
    options = BuildOptions(output_dir=Path(directory), source_dir=Path('src/doc'))
              ^^^^^^^^^^^^
NameError: name 'BuildOptions' is not defined
....: options = BuildOptions(output_dir=Path(directory), source_dir=Path('src/doc'))
....: builder = DocBuilder('en/tutorial', options)
....: builder._output_dir('html')
Expand All @@ -203,10 +203,10 @@

EXAMPLES::

sage: from sage_docbuild.builders import DocBuilder

Check failure on line 206 in src/sage_docbuild/builders.py

View workflow job for this annotation

GitHub Actions / Conda (ubuntu, Python 3.12, new)

Failed example: 

Failed example:: Exception raised:
Traceback (most recent call last):
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 734, in _run
    self.compile_and_execute(example, compiler, test.globs)
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 1158, in compile_and_execute
    exec(compiled, globs)
  File "<doctest sage_docbuild.builders.DocBuilder.Path[0]>", line 1, in <module>
    from sage_docbuild.builders import DocBuilder
ModuleNotFoundError: No module named 'sage_docbuild'
sage: from sage_docbuild.build_options import BuildOptions

Check failure on line 207 in src/sage_docbuild/builders.py

View workflow job for this annotation

GitHub Actions / Conda (ubuntu, Python 3.12, new)

Failed example: 

Failed example:: Exception raised:
Traceback (most recent call last):
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 734, in _run
    self.compile_and_execute(example, compiler, test.globs)
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 1158, in compile_and_execute
    exec(compiled, globs)
  File "<doctest sage_docbuild.builders.DocBuilder.Path[1]>", line 1, in <module>
    from sage_docbuild.build_options import BuildOptions
ModuleNotFoundError: No module named 'sage_docbuild'
sage: import tempfile
sage: with tempfile.TemporaryDirectory() as directory:

Check failure on line 209 in src/sage_docbuild/builders.py

View workflow job for this annotation

GitHub Actions / Conda (ubuntu, Python 3.12, new)

Failed example: 

Failed example:: Exception raised:
Traceback (most recent call last):
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 734, in _run
    self.compile_and_execute(example, compiler, test.globs)
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 1158, in compile_and_execute
    exec(compiled, globs)
  File "<doctest sage_docbuild.builders.DocBuilder.Path[3]>", line 2, in <module>
    options = BuildOptions(output_dir=Path(directory), source_dir=Path('src/doc'))
              ^^^^^^^^^^^^
NameError: name 'BuildOptions' is not defined
....: options = BuildOptions(output_dir=Path(directory), source_dir=Path('src/doc'))
....: builder = DocBuilder('en/tutorial', options)
....: builder._doctrees_dir()
Expand All @@ -222,10 +222,10 @@

EXAMPLES::

sage: from sage_docbuild.builders import DocBuilder

Check failure on line 225 in src/sage_docbuild/builders.py

View workflow job for this annotation

GitHub Actions / Conda (ubuntu, Python 3.12, new)

Failed example: 

Failed example:: Exception raised:
Traceback (most recent call last):
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 734, in _run
    self.compile_and_execute(example, compiler, test.globs)
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 1158, in compile_and_execute
    exec(compiled, globs)
  File "<doctest sage_docbuild.builders.DocBuilder._output_formats[0]>", line 1, in <module>
    from sage_docbuild.builders import DocBuilder
ModuleNotFoundError: No module named 'sage_docbuild'
sage: from sage_docbuild.build_options import BuildOptions

Check failure on line 226 in src/sage_docbuild/builders.py

View workflow job for this annotation

GitHub Actions / Conda (ubuntu, Python 3.12, new)

Failed example: 

Failed example:: Exception raised:
Traceback (most recent call last):
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 734, in _run
    self.compile_and_execute(example, compiler, test.globs)
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 1158, in compile_and_execute
    exec(compiled, globs)
  File "<doctest sage_docbuild.builders.DocBuilder._output_formats[1]>", line 1, in <module>
    from sage_docbuild.build_options import BuildOptions
ModuleNotFoundError: No module named 'sage_docbuild'
sage: options = BuildOptions(source_dir=Path('src/doc'))

Check failure on line 227 in src/sage_docbuild/builders.py

View workflow job for this annotation

GitHub Actions / Conda (ubuntu, Python 3.12, new)

Failed example: 

Failed example:: Exception raised:
Traceback (most recent call last):
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 734, in _run
    self.compile_and_execute(example, compiler, test.globs)
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 1158, in compile_and_execute
    exec(compiled, globs)
  File "<doctest sage_docbuild.builders.DocBuilder._output_formats[2]>", line 1, in <module>
    options = BuildOptions(source_dir=Path('src/doc'))
              ^^^^^^^^^^^^
NameError: name 'BuildOptions' is not defined
sage: builder = DocBuilder('tutorial', options)

Check failure on line 228 in src/sage_docbuild/builders.py

View workflow job for this annotation

GitHub Actions / Conda (ubuntu, Python 3.12, new)

Failed example: 

Failed example:: Exception raised:
Traceback (most recent call last):
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 734, in _run
    self.compile_and_execute(example, compiler, test.globs)
  File "/usr/share/miniconda/envs/sage-dev/lib/python3.12/site-packages/sage/doctest/forker.py", line 1158, in compile_and_execute
    exec(compiled, globs)
  File "<doctest sage_docbuild.builders.DocBuilder._output_formats[3]>", line 1, in <module>
    builder = DocBuilder('tutorial', options)
              ^^^^^^^^^^
NameError: name 'DocBuilder' is not defined
sage: builder._output_formats()
['changes', 'html', 'htmlhelp', 'inventory', 'json', 'latex', 'linkcheck', 'pickle', 'web']
"""
Expand Down Expand Up @@ -1227,7 +1227,7 @@
n = len(list(directory.iterdir()))
documents.append((-n, directory.relative_to(source)))

# Sort largest component (most subdirectory entries) first since
# Sort largest component (most subdirectory entries) first since
# they will take the longest to build
docs = [doc[1] for doc in sorted(documents)]
# Put the bibliography first, because it needs to be built first:
Expand Down
Loading