building documentation for a single user file

[Vincent Delecroix]

Hello,

As specified in the documentation given with "sage -docbuild -D" it
should be possible to make the documentation of a single file. But this
is what I get

$ sage -docbuild file=/path/to/test_doc.py html
[html ] loading pickled environment... not yet created
[html ] Compiling the master document
[html ] building [mo]: targets for 0 po files that are out of date
[html ] building [html]: targets for 1 source files that are out of date
[html ] updating environment: 1 added, 0 changed, 0 removed
[html ] reading sources... [100%] index
[html ] Merging environment/index files...
[html ] ... done (0 todos, 1 index, 0 citations, 1 modules)
[html ] Exception occurred:
[html ] File "/opt/sage/src/sage_setup/docbuild/ext/multidocs.py",
line 206, in citation_dir
[html ] assert app.outdir.startswith(SAGE_DOC)
[html ] AssertionError
[html ] The full traceback has been saved in
/tmp/sphinx-err-YVJ9y3.log, if you want to report the issue to the
developers.
[html ] Please also report this if it was a user error, so that a
better error message can be provided next time.
[html ] A bug report can be filed in the tracker at
<https://github.com/sphinx-doc/sphinx/issues>. Thanks!
Error building the documentation.
Traceback (most recent call last):
File "/opt/sage/local/lib/python/runpy.py", line 162, in
_run_module_as_main
"__main__", fname, loader, pkg_name)
File "/opt/sage/local/lib/python/runpy.py", line 72, in _run_code
exec code in run_globals
File
"/opt/sage/local/lib/python2.7/site-packages/sage_setup/docbuild/__main__.py",
line 2, in <module>
main()
File
"/opt/sage/local/lib/python2.7/site-packages/sage_setup/docbuild/__init__.py",
line 1630, in main
builder()
File
"/opt/sage/local/lib/python2.7/site-packages/sage_setup/docbuild/__init__.py",
line 103, in f
runsphinx()
File
"/opt/sage/local/lib/python2.7/site-packages/sage_setup/docbuild/sphinxbuild.py",
line 215, in runsphinx
raise exception
OSError: [html ] Exception occurred:

Any help on whether this is supported and how to slove this is welcome!

Vincent

[John H Palmieri]

This is not a permanent solution, but try commenting out that assertion. That is, in the file src/sage_setup/docbuild/ext/multidocs.py, comment out line 206,

   assert app.outdir.startswith(SAGE_DOC)

Then run 'make' to install this change, and try building the docs again.