Creation of Leo's Documentation locally in 6.1b1?

83 views
Skip to first unread message

Viktor Ransmayr

unread,
Oct 29, 2019, 4:44:25 AM10/29/19
to leo-e...@googlegroups.com
Hello Edward, hello Matt,

This is a follow-up question, now that I have Leo 6.1b1 installed from PyPI.

Should it be possible to create a local version of Leo's Documentation out of the box w/o making any modifications to "LeoDocs.leo"?

Reason for my question: I see that docutils & sphinx are installed - but - no HTML files are created in
  • C:/Users/Viktor/PyVE/Leo-6.1-b1/Lib/site-packages/leo/doc/html/
With kind regards,

Viktor

Edward K. Ream

unread,
Oct 29, 2019, 9:56:33 AM10/29/19
to leo-editor
On Tue, Oct 29, 2019 at 3:44 AM Viktor Ransmayr <viktor....@gmail.com> wrote:

Should it be possible to create a local version of Leo's Documentation out of the box w/o making any modifications to "LeoDocs.leo"?

Yes.  LeoDocs.leo is the official source for Leo's docs.  Choose the node "Leo's Documentation" and run the rst3 command.  This creates files which can be turned into .html files using `make html` from the leo-editor\leo\doc\html directory.

Edward

Viktor Ransmayr

unread,
Apr 4, 2020, 3:40:15 PM4/4/20
to leo-editor
Hello Edward, hello Matt,
As stated already previously I'm in the process of re-checking all issues, that I had reported, when I was using Leo only on a Windows PC ...

I'm still not able to create Leo's documentation locally!

At least not for Fedora 30. - See the error message, when I try to follow your recommended steps:

###

Open the outline "LeoDocs.leo" locally. - OK.

* See "Log-001"

Choose the node "Leo's Documentation" and run the rst3 command. - OK.

* See "Log-002"

Create the ".html" files using `make html` from the 'leo-editor/leo/doc/html/' directory. - Not OK. - See

[user@fedora-leo-study-vm html]$ pwd
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html
[user@fedora-leo-study-vm html]$ make html
make
: *** No rule to make target 'html'.  Stop.
[user@fedora-leo-study-vm html]$


###

FYI @Matt : As always I've installed Leo 6.2.1 via pip from PyPI into a dedicated PyVE on Fedora 30 ...

Shall I open a new issue for this problem?

With kind regards,

Viktor

Thomas Passin

unread,
Apr 4, 2020, 6:04:45 PM4/4/20
to leo-editor

On Saturday, April 4, 2020 at 3:40:15 PM UTC-4, Viktor Ransmayr wrote:
Hello Edward, hello Matt,

Am Dienstag, 29. Oktober 2019 14:56:33 UTC+1 schrieb Edward K. Ream:
On Tue, Oct 29, 2019 at 3:44 AM Viktor Ransmayr <viktor....@gmail.com> wrote:

Should it be possible to create a local version of Leo's Documentation out of the box w/o making any modifications to "LeoDocs.leo"?

Yes.  LeoDocs.leo is the official source for Leo's docs.  Choose the node "Leo's Documentation" and run the rst3 command.  This creates files which can be turned into .html files using `make html` from the leo-editor\leo\doc\html directory.

As stated already previously I'm in the process of re-checking all issues, that I had reported, when I was using Leo only on a Windows PC ...

I'm still not able to create Leo's documentation locally!

At least not for Fedora 30. - See the error message, when I try to follow your recommended steps:

###

Open the outline "LeoDocs.leo" locally. - OK.

* See "Log-001"

Choose the node "Leo's Documentation" and run the rst3 command. - OK.

* See "Log-002"

Create the ".html" files using `make html` from the 'leo-editor/leo/doc/html/' directory. - Not OK. - See

[user@fedora-leo-study-vm html]$ pwd
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html
[user@fedora-leo-study-vm html]$ make html
make
: *** No rule to make target 'html'.  Stop.
[user@fedora-leo-study-vm html]$


It is quite feasible to create Sphinx documentation without using make to generate or invoke a Sphinx configuration file.  You really only need the config file if you need a lot of config settings.  Here's an example of what I've done in the past - in this case, for a master document called "dd1" -

Here is an example command line, which I put into a script button node (running it with POpen):

    python -m sphinx -C -D  master_doc=dd1 -D source_suffix=.txt . result
   
The command line parameters are -C to skip the conf.py file, and the two -D options to specify things that would otherwise be in the conf.py file:

     -D source_suffix=.txt  -- Rst file extension will be .txt.
    -D master_doc=dd1      -- the main rst file is named "dd1.txt"
    -D html_theme=sphinx_rtd_theme -- use the Read-the-Docs theme.
    -D "project=Project Name" -- Set the project Name for display.
    -D "copyright=Author" -- Use this copyright string.
 

Other -D settings are listed at http://www.sphinx-doc.org/en/master/usage/configuration.html.
   
The source directory is the current one ("."), and the output will be in a "result" directory.  In this example, where the source is named dd1.txt, the main HTML file will be at result/dd1.html.

If you want to user the Read-the-Docs theme, sphinx_rtd_theme, IIRC it comes in a package that can be pip-installed.

Viktor Ransmayr

unread,
Apr 5, 2020, 3:21:22 AM4/5/20
to leo-e...@googlegroups.com
Hello Thomas,

Am So., 5. Apr. 2020 um 00:04 Uhr schrieb Thomas Passin <tbp1...@gmail.com>:

On Saturday, April 4, 2020 at 3:40:15 PM UTC-4, Viktor Ransmayr wrote:
Hello Edward, hello Matt,

Am Dienstag, 29. Oktober 2019 14:56:33 UTC+1 schrieb Edward K. Ream:
On Tue, Oct 29, 2019 at 3:44 AM Viktor Ransmayr <viktor....@gmail.com> wrote:

Should it be possible to create a local version of Leo's Documentation out of the box w/o making any modifications to "LeoDocs.leo"?

Yes.  LeoDocs.leo is the official source for Leo's docs.  Choose the node "Leo's Documentation" and run the rst3 command.  This creates files which can be turned into .html files using `make html` from the leo-editor\leo\doc\html directory.

As stated already previously I'm in the process of re-checking all issues, that I had reported, when I was using Leo only on a Windows PC ...

I'm still not able to create Leo's documentation locally!

At least not for Fedora 30. - See the error message, when I try to follow your recommended steps:

###

Open the outline "LeoDocs.leo" locally. - OK.

* See "Log-001"

Choose the node "Leo's Documentation" and run the rst3 command. - OK.

* See "Log-002"

Create the ".html" files using `make html` from the 'leo-editor/leo/doc/html/' directory. - Not OK. - See

[user@fedora-leo-study-vm html]$ pwd
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html
[user@fedora-leo-study-vm html]$ make html
make
: *** No rule to make target 'html'.  Stop.
[user@fedora-leo-study-vm html]$


It is quite feasible to create Sphinx documentation without using make to generate or invoke a Sphinx configuration file.  You really only need the config file if you need a lot of config settings.  Here's an example of what I've done in the past - in this case, for a master document called "dd1" -

Here is an example command line, which I put into a script button node (running it with POpen):

Thanks a lot for your feedback. - I'll look into this tonight - and - will report back on my progress.

With kind regards,

Viktor

Viktor Ransmayr

unread,
Apr 5, 2020, 9:48:09 AM4/5/20
to leo-editor
Hello everyone,
I made some *limited* progress, which I'd like to share with you. - Here are my notes:

###

Investigate in detail the suggestions made by Thomas. - See

* https://groups.google.com/d/msg/leo-editor/lOBQ0fkWtpA/MvKSsrk2BAAJ

The Sphinx configuration file "conf.py" for Leo's documentation is already provided as part of the installation. - See

* /home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/

Try out 'make-sphinx' button offered in outline 'LeoDocs.leo'. - Not OK. - See "Log-001".

* The same error is reported as if I follow the instructions manually ...

The name of the master toctree document is 'leo_toc.html.txt'. It contains a list of all file to be included - and - is also included as part of the installation. - See

* /home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/

Try out the suggestion from Thomas - and - start Sphinx directly using Python in this directory. - Partially OK. - See "Log-002"

### Log-001

rst3: 51 files in 0.50 sec.
execute_shell_commands make clean
make: *** No rule to make target 'clean'.  Stop.
execute_shell_commands make html

make: *** No rule to make target 'html'.  Stop.

### Log-002

(Leo-stable) [user@fedora-leo-study-vm html]$ python -m sphinx -D master_doc=leo_toc.html -D source_suffix=.txt . ./_build/html
Running Sphinx v2.4.4
===== conf.py: .md files NOT enabled
WARNING: html_static_path entry '_static' does not exist
WARNING: logo file 'Leo4-80-border.jpg' does not exist
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 50 source files that are out of date
updating environment: [new config] 50 added, 0 changed, 0 removed
reading sources... [100%] zodb.html                                            
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/console-gui.html.txt:7: WARNING: image file not readable: screen-shots/console-window.png
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/getting-started.html.txt:13: WARNING: toctree contains reference to nonexisting document 'download'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/getting-started.html.txt:13: WARNING: toctree contains reference to nonexisting document 'installing'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/getting-started.html.txt:13: WARNING: toctree contains reference to nonexisting document 'running'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/intermediatetopics.html.txt:7: WARNING: toctree contains reference to nonexisting document 'coloring'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/intermediatetopics.html.txt:7: WARNING: toctree contains reference to nonexisting document 'writingPlugins'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/intermediatetopics.html.txt:7: WARNING: toctree contains reference to nonexisting document 'unitTesting'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/intermediatetopics.html.txt:7: WARNING: toctree contains reference to nonexisting document 'debuggers'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/intermediatetopics.html.txt:7: WARNING: toctree contains reference to nonexisting document 'console-gui'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/intermediatetopics.html.txt:16: WARNING: toctree contains reference to nonexisting document 'scripting-miscellany'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/intermediatetopics.html.txt:16: WARNING: toctree contains reference to nonexisting document 'theory'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/intermediatetopics.html.txt:16: WARNING: toctree contains reference to nonexisting document 'vim-theory'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/intermediatetopics.html.txt:16: WARNING: toctree contains reference to nonexisting document 'leonine-world'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/intermediatetopics.html.txt:16: WARNING: toctree contains reference to nonexisting document 'leo-university'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leo_toc.html.txt:14: WARNING: toctree contains reference to nonexisting document 'preliminaries'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leo_toc.html.txt:19: WARNING: toctree contains reference to nonexisting document 'getting-started'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leo_toc.html.txt:24: WARNING: toctree contains reference to nonexisting document 'cheatsheet'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leo_toc.html.txt:29: WARNING: toctree contains reference to nonexisting document 'screencasts'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leo_toc.html.txt:29: WARNING: toctree contains reference to nonexisting document 'tutorial'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leo_toc.html.txt:29: WARNING: toctree contains reference to nonexisting document 'usersguide'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leo_toc.html.txt:29: WARNING: toctree contains reference to nonexisting document 'leoandotherprograms'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leo_toc.html.txt:29: WARNING: toctree contains reference to nonexisting document 'intermediatetopics'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leo_toc.html.txt:29: WARNING: toctree contains reference to nonexisting document 'appendices'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leo_toc.html.txt:39: WARNING: toctree contains reference to nonexisting document 'history'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leo_toc.html.txt:39: WARNING: toctree contains reference to nonexisting document 'FAQ'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leo_toc.html.txt:39: WARNING: toctree contains reference to nonexisting document 'glossary'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leo_toc.html.txt:39: WARNING: toctree contains reference to nonexisting document 'what-is-new'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leo_toc.html.txt:47: WARNING: toctree contains reference to nonexisting document 'slides'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leo_toc.html.txt:47: WARNING: toctree contains reference to nonexisting document 'leoLinks'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leo_toc.html.txt:47: WARNING: toctree contains reference to nonexisting document 'screen-shots'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leoandotherprograms.html.txt:7: WARNING: toctree contains reference to nonexisting document 'leoandasciidoc'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leoandotherprograms.html.txt:7: WARNING: toctree contains reference to nonexisting document 'emacs'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leoandotherprograms.html.txt:7: WARNING: toctree contains reference to nonexisting document 'vimBindings'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leoandotherprograms.html.txt:7: WARNING: toctree contains reference to nonexisting document 'leoBridge'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leoandotherprograms.html.txt:7: WARNING: toctree contains reference to nonexisting document 'IPythonBridge'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leoandotherprograms.html.txt:7: WARNING: toctree contains reference to nonexisting document 'zodb'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/preliminaries.html.txt:11: WARNING: toctree contains reference to nonexisting document 'preface'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/preliminaries.html.txt:11: WARNING: toctree contains reference to nonexisting document 'testimonials'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/preliminaries.html.txt:11: WARNING: toctree contains reference to nonexisting document 'acknowledgements'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/preliminaries.html.txt:11: WARNING: toctree contains reference to nonexisting document 'license'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/screen-shots.html.txt:: WARNING: image file not readable: screen-shots/leo-main-window.png
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/screen-shots.html.txt:: WARNING: image file not readable: screen-shots/emacs-config.png
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/screen-shots.html.txt:: WARNING: image file not readable: screen-shots/leo-qt-main-window-linux.png
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/screen-shots.html.txt:: WARNING: image file not readable: screen-shots/render-rst.png
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/screen-shots.html.txt:: WARNING: image file not readable: screen-shots/render-svg-movie.png
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/screen-shots.html.txt:: WARNING: image file not readable: screen-shots/render-svg-sources.png
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/screen-shots.html.txt:: WARNING: image file not readable: screen-shots/render-splash-screen.png
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/screen-shots.html.txt:70: WARNING: image file not readable: screen-shots/leo-thesis.png
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/tutorial-basics.html.txt:: WARNING: image file not readable: screen-shots/leo-workbook.png
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/tutorial.html.txt:26: WARNING: toctree contains reference to nonexisting document 'tutorial-basics'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/tutorial.html.txt:26: WARNING: toctree contains reference to nonexisting document 'tutorial-pim'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/tutorial.html.txt:26: WARNING: toctree contains reference to nonexisting document 'tutorial-rst3'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/tutorial.html.txt:35: WARNING: toctree contains reference to nonexisting document 'tutorial-scripting'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/tutorial.html.txt:42: WARNING: toctree contains reference to nonexisting document 'tutorial-tips'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/usersguide.html.txt:20: WARNING: toctree contains reference to nonexisting document 'customizing'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/usersguide.html.txt:20: WARNING: toctree contains reference to nonexisting document 'rstplugin3'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/usersguide.html.txt:20: WARNING: toctree contains reference to nonexisting document 'plugins'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/usersguide.html.txt:20: WARNING: toctree contains reference to nonexisting document 'commands'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/usersguide.html.txt:20: WARNING: toctree contains reference to nonexisting document 'directives'
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/what-is-new.html.txt:29: WARNING: Unexpected indentation.
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/what-is-new.html.txt:30: WARNING: Block quote ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/FAQ.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/IPythonBridge.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/acknowledgements.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/appendices.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/cheatsheet.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/coloring.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/commands.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/console-gui.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/customizing.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/debuggers.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/directives.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/download.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/emacs.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/getting-started.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/glossary.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/history.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/installing.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/intermediatetopics.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leo-university.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leoBridge.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leoLinks.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leoandasciidoc.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leoandotherprograms.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/leonine-world.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/license.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/plugins.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/preface.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/preliminaries.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/rstplugin3.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/running.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/screen-shots.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/screencasts.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/scripting-miscellany.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/slides.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/testimonials.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/theory.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/tutorial-basics.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/tutorial-pim.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/tutorial-rst3.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/tutorial-scripting.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/tutorial-tips.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/tutorial.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/unitTesting.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/usersguide.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/vim-theory.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/vimBindings.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/what-is-new.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/writingPlugins.html.txt: WARNING: document isn't included in any toctree
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/zodb.html.txt: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] zodb.html                                             
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/screen-shots.html.txt:: WARNING: Could not obtain image size. :scale: option is ignored.
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/screen-shots.html.txt:: WARNING: Could not obtain image size. :scale: option is ignored.
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/screen-shots.html.txt:: WARNING: Could not obtain image size. :scale: option is ignored.
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/screen-shots.html.txt:: WARNING: Could not obtain image size. :scale: option is ignored.
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/screen-shots.html.txt:: WARNING: Could not obtain image size. :scale: option is ignored.
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/screen-shots.html.txt:: WARNING: Could not obtain image size. :scale: option is ignored.
/home/user/PyVE/PyPI/Leo-stable/lib/python3.7/site-packages/leo/doc/html/screen-shots.html.txt:: WARNING: Could not obtain image size. :scale: option is ignored.
generating indices...  genindexdone
writing additional pages...  searchdone
copying static files... ... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 119 warnings.

The HTML pages are in _build/html.
(Leo-stable) [user@fedora-leo-study-vm html]$

### End of logs ...

@Edward: IMO it would be really nice, if Leo's documentation could be *locally* generated & extended.

As far as I can tell, this is not possible following the instructions provided in
  • /home/user/PyVE/PyPI/Leo-stable/lib64/python3.7/site-packages/leo/doc/LeoDocs.leo#Leo's Documentation
Shall I create an issue in GitHub for this?

With kind regards,

Viktor

Edward K. Ream

unread,
Apr 5, 2020, 10:04:04 AM4/5/20
to leo-editor
On Sun, Apr 5, 2020 at 8:48 AM Viktor Ransmayr <viktor....@gmail.com> wrote:

@Edward: IMO it would be really nice, if Leo's documentation could be *locally* generated & extended.
[big snip]
 
As far as I can tell, this is not possible following the instructions provided in
  • /home/user/PyVE/PyPI/Leo-stable/lib64/python3.7/site-packages/leo/doc/LeoDocs.leo#Leo's Documentation
Shall I create an issue in GitHub for this?

Yes. In future, always feel free to create a new issue. There is no harm in doing so.

Edward

Viktor Ransmayr

unread,
Apr 5, 2020, 10:21:29 AM4/5/20
to leo-e...@googlegroups.com
Hello Edward,

Done. - See
Reply all
Reply to author
Forward
0 new messages