search

sagemath / sagenb

Sage Notebook (flask), docs in $SAGE_LOCAL/share/doc/sagenb/index.html
Other
116 stars 97 forks source link

Use Sage's version of sphinxify. #466

Closed jhpalmieri closed 5 years ago

jhpalmieri commented 5 years ago

See #465

dimpase commented 5 years ago

This does not work - if I create an spkg and try installing it in Sage, I get

...
[sagenb-1.1.1]     Running setup.py install for sagenb: finished with status 'done'
[sagenb-1.1.1]   Removing source in /tmp/pip-req-build-VWelY7
[sagenb-1.1.1] Successfully installed sagenb-1.1.1
[sagenb-1.1.1] Cleaning up...
[sagenb-1.1.1] Removed build tracker '/tmp/pip-req-tracker-hpWBYZ'
[sagenb-1.1.1] ./spkg-install: line 37: cd: doc: No such file or directory
[sagenb-1.1.1] make[2]: Entering directory '/mnt/opt/Sage/sage-dev/local/var/tmp/sage/build/sagenb-1.1.1/src'
[sagenb-1.1.1] make[2]: *** No rule to make target 'html'.  Stop.
[sagenb-1.1.1] make[2]: Leaving directory '/mnt/opt/Sage/sage-dev/local/var/tmp/sage/build/sagenb-1.1.1/src'
[sagenb-1.1.1] ********************************************************************************
[sagenb-1.1.1] Error building the documentation
...

Compare this with the sucessful run without this patch:

...
    Running setup.py install for sagenb: finished with status 'done'
  Removing source in /tmp/pip-req-build-FLm7uG
Successfully installed sagenb-1.1.1
Cleaning up...
Removed build tracker '/tmp/pip-req-tracker-Cx7_uV'
make[2]: Entering directory '/mnt/opt/Sage/sage-dev/local/var/tmp/sage/build/sagenb-1.1.1/src/doc'
Running Sphinx v1.7.6
making output directory...
...
dimpase commented 5 years ago

Sorry, our spkg building is broken currently. So probably your PR is OK...

dimpase commented 5 years ago

ok, thanks, this is an improvement!

dimpase commented 5 years ago

By the way, at what point this sphinxify.py is used, and how? It's a bit of a mystery to me. Is it "magically" loaded by sphinx while generating html docs?

jhpalmieri commented 5 years ago

It's used in misc/support.py by html_markup which is used by docstring, which is called in notebook/worksheet.py for introspection.