Skip to content

Use SAGE_DOC_SRC instead of relative path in docbuilder test #40895

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
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Use SAGE_DOC_SRC instead of relative path in docbuilder test #40895

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions src/sage_docbuild/builders.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,10 +180,10 @@

EXAMPLES::

sage: from sage_docbuild.builders import DocBuilder

Check failure on line 183 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 733, 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 1157, 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 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 733, 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 1157, 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 186 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 733, 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 1157, 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 @@ -202,10 +202,10 @@

EXAMPLES::

sage: from sage_docbuild.builders import DocBuilder

Check failure on line 205 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 733, 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 1157, 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 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 733, 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 1157, 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 208 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 733, 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 1157, 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 @@ -221,10 +221,10 @@

EXAMPLES::

sage: from sage_docbuild.builders import DocBuilder

Check failure on line 224 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 733, 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 1157, 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 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 733, 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 1157, 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 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 733, 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 1157, 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 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 733, 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 1157, 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 @@ -1180,7 +1180,8 @@
EXAMPLES::

sage: from sage_docbuild.builders import get_all_documents
sage: documents = get_all_documents(Path('src/doc'))
sage: from sage.env import SAGE_DOC_SRC
sage: documents = get_all_documents(Path(SAGE_DOC_SRC))
sage: Path('en/tutorial') in documents
True
"""
Expand Down Expand Up @@ -1213,7 +1214,8 @@
EXAMPLES::

sage: from sage_docbuild.builders import get_all_reference_documents
sage: documents = get_all_reference_documents(Path('src/doc/en'))
sage: from sage.env import SAGE_DOC_SRC
sage: documents = get_all_reference_documents(Path(SAGE_DOC_SRC) / 'en')
sage: Path('reference/algebras') in documents
True
"""
Expand Down
Loading