Re: Unable to create Leo's Documentation locally

Viktor Ransmayr Sat, 18 Mar 2023 10:28:10 -0700

Hello Thomas

[email protected] schrieb am Freitag, 17. März 2023 um 14:39:46 UTC+1:

The following script will build everything except the slides. Either it
needs to be run from the *leo/doc* directory or the path needs to be added
to the script instead of the "." in the last line:

#see https://github.com/leo-editor/leo-editor/issues/1566
import sys
import subprocess
pyexe=sys.executable
cmd=[pyexe,'-m','sphinx','-C',
'-D', 'master_doc=html/leo_toc',
'-D', 'source_suffix=.html.txt',
'-D', 'html_theme=sphinx_rtd_theme',
'-D', 'project=LeoDocs',
'.', r'c:\temp\result']

subprocess.call(cmd)

To use the theme, IIRC, it needs to be installed from PyPi first. Run the
script with the usual CNTL-b.

I first worked this up in 2020. I just now tried it out to see if it still
works by pasting it into a new node at the top of the LeoDocs outline.
Change the "result" location in the last line to suit yourself.

I used a slightly simpler version, since I did not want to add any
dependency & make it non-windows specific:

import sys
import subprocess
pyexe = sys.executable
cmd = [pyexe, '-m', 'sphinx', '-C',
'-D', 'master_doc=html/leo_toc',
'-D', 'source_suffix=.html.txt',
'-D', 'project=Leo Docs',
'.', 'result']

subprocess.call(cmd)

It works kind of OK - but - did reveal, that Leo's Documentation Outline is
still assuming that development & release work is done on Windows ...

Below are my logs w/ more details.

With kind regards,

Viktor

###

Execute this button on the "Leo's Documentation" node of the outline - OK -
See "Log-002".

* Check out the result ...
*
file:///home/user/PyVE/GitHub/Leo/leo-editor/leo/doc/result/html%5Cleo_toc.html
<- ?
* ->
file:///home/user/PyVE/GitHub/Leo/leo-editor/leo/doc/result/html/leo_toc.html
<- !
* ... and compare it with
* https://leo-editor.github.io/leo-editor/leo_toc.html

### Log-002

(Leo) user@debian-leo-study-vm:~/PyVE/GitHub/Leo/leo-editor/leo$
(Leo) user@debian-leo-study-vm:~/PyVE/GitHub/Leo/leo-editor/leo$
Running Sphinx v4.3.1
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 49 source files that are out of date
updating environment: [config changed ('project')] 133 added, 0
changed, 0 removed
reading sources... [100%] html/writingPlugins

/home/user/PyVE/GitHub/Leo/leo-editor/leo/doc/html/intermediatetopics.html.txt:7:

WARNING: toctree contains reference to nonexisting document
'html/unitTesting'
/home/user/PyVE/GitHub/Leo/leo-editor/leo/doc/html/leo_toc.html.txt:24:
WARNING: toctree contains reference to nonexisting document
'html/toc-more-links'
looking for now-outdated files... none found
pickling environment... done
checking consistency...
/home/user/PyVE/GitHub/Leo/leo-editor/leo/doc/html/FAQ.html.txt: WARNING:
document isn't included in any toctree
/home/user/PyVE/GitHub/Leo/leo-editor/leo/doc/html/cheatsheet.html.txt:
WARNING: document isn't included in any toctree
/home/user/PyVE/GitHub/Leo/leo-editor/leo/doc/html/glossary.html.txt:
WARNING: document isn't included in any toctree
/home/user/PyVE/GitHub/Leo/leo-editor/leo/doc/html/history.html.txt:
WARNING: document isn't included in any toctree
/home/user/PyVE/GitHub/Leo/leo-editor/leo/doc/html/leoLinks.html.txt:
WARNING: document isn't included in any toctree

/home/user/PyVE/GitHub/Leo/leo-editor/leo/doc/html/screen-shots.html.txt:
WARNING: document isn't included in any toctree

/home/user/PyVE/GitHub/Leo/leo-editor/leo/doc/html/screencasts.html.txt:
WARNING: document isn't included in any toctree
/home/user/PyVE/GitHub/Leo/leo-editor/leo/doc/html/slides.html.txt:
WARNING: document isn't included in any toctree

/home/user/PyVE/GitHub/Leo/leo-editor/leo/doc/html/slides/basics/basics.html.txt: