rev 3b6b820c: first crack at pip install docs

[Matt Wilkie]

https://github.com/leo-editor/leo-editor/commit/3b6b820c105df6f7c53cadedcec776c0974542d9

Note: they don't work yet because there is no package on pypi.org! I got to fighting with git conflicts and have run out of time. More later. Sorry

Matt

[Edward K. Ream]

On Tuesday, November 28, 2017 at 5:00:26 PM UTC-6, Matt Wilkie wrote:

https://github.com/leo-editor/leo-editor/commit/3b6b820c105df6f7c53cadedcec776c0974542d9

Note: they don't work yet because there is no package on pypi.org! I got to fighting with git conflicts and have run out of time. More later. Sorry

Rev 4a99f36 reverts LeoDocs.leo to rev 92de60593.  It can not be loaded.

Edward

[Matt Wilkie]

Eeep! sorry about that!

I fixed the botched LeoDocs.leo edit, and have now uploaded a package to https://pypi.python.org/pypi/leo :)

`pip install leo` for end users and `pip install leo[develop]` for the extras like pylint should work for most people now.

WRT to the docs, I'm not sure if I used the right structure about where to put in table of contents, sections headings and all that. I'm not attached to any of it. Please free to edit.

matt

--
You received this message because you are subscribed to the Google Groups "leo-editor" group.
To unsubscribe from this group and stop receiving emails from it, send an email to leo-editor+unsubscribe@googlegroups.com.
To post to this group, send email to leo-e...@googlegroups.com.
Visit this group at https://groups.google.com/group/leo-editor.
For more options, visit https://groups.google.com/d/optout.

[Edward K. Ream]

On Wed, Nov 29, 2017 at 6:09 PM, Matt Wilkie <map...@gmail.com> wrote:

Eeep! sorry about that!

​No problem.  As long a nobody uses --force we can easily recover from mistakes ;-)

​

I fixed the botched LeoDocs.leo edit, and have now uploaded a package to https://pypi.python.org/pypi/leo :)

`pip install leo` for end users and `pip install leo[develop]` for the extras like pylint should work for most people now.

​That's excellent.​

WRT to the docs, I'm not sure if I used the right structure about where to put in table of contents, sections headings and all that. I'm not attached to any of it. Please free to edit.

​Where are the new docs?  In future, it would be easiest to put clone new nodes as the last top-level nodes of LeoDocs.leo  That way devs and interested users can see at a glance what has changed.

Edward

[Matt Wilkie]

​Where are the new docs?  In future, it would be easiest to put clone new nodes as the last top-level nodes of LeoDocs.leo  That way devs and interested users can see at a glance what has changed.

ok, in future I'll do that. For this time see .../leo/doc/LeoDocs.leo#Leo's Documentation-->Installing & running Leo-->@rst html/quick.html

[Edward K. Ream]

On Thu, Nov 30, 2017 at 10:59 PM, Matt Wilkie <map...@gmail.com> wrote:

​Where are the new docs?  In future, it would be easiest to put clone new nodes as the last top-level nodes of LeoDocs.leo  That way devs and interested users can see at a glance what has changed.

ok, in future I'll do that. For this time see .../leo/doc/LeoDocs.leo#Leo's Documentation-->Installing & running Leo-->@rst html/quick.html

​There are three nodes in the "quick" tree.  Imo, all three nodes must have some introductory words succinctly explaining what is being discussed. This is not easy to do.  Lewis, do you have any suggestions?

Edward

[Edward K. Ream]

On Friday, December 1, 2017 at 3:36:02 AM UTC-6, Edward K. Ream wrote

There are three nodes in the "quick" tree.  Imo, all three nodes must have some introductory words succinctly explaining what is being discussed. This is not easy to do.  Lewis, do you have any suggestions?

Also, the title of the "chapter" should be something other than "quick start".  Something like, "Overview of installing x", but I'm not quite sure what x should be ;-)

Edward

[Edward K. Ream]

On Thursday, November 30, 2017 at 10:59:27 PM UTC-6, Matt Wilkie wrote:

ok, in future I'll do that. For this time see .../leo/doc/LeoDocs.leo#Leo's Documentation-->Installing & running Leo-->@rst html/quick.html

Imo, putting instructions in a separate section would slow users down. Worse, it would confuse them. For this reason, I have removed the reference to "quick" from the node:

    @rst html/getting-started.html

Instead, the remarks should be folded into the node:

    @rst html/installing.html-->Installing packages

This is not a trivial task.  Lewis, any help you could give with this merging would be helpful.

Edward

[lewis]

I'll try and squeeze some time from the weekend and slap on my user's hat....

Lewis

[Matt Wilkie]

thank you Lewis, that would be much appreciated. :) I continually struggle with how to balance level of detail between anemic and overwhelming.
​

[lewis]

Leo's documentation at http://leoeditor.com/installing.html now has an obsolete link at

 Installing Leo > Installing packages

 Download PyQt5 from http://www.riverbankcomputing.com/software/pyqt/download5.

It seems the PyQt webpage has been recently updated. The link for PyQt5 via the Riverbankcomputing site is http://pyqt.sourceforge.net/Docs/PyQt5/

New Leo users who need to install PyQt5 should be directed to http://pyqt.sourceforge.net/Docs/PyQt5/installation.html 

This highlights the importance of equipping Leo users to use pip easily. Since PyQt5 v5.7, the only easy method to install has been using pip3.

I will incorporate this into the revised installation docs.

Regards

Lewis

[Edward K. Ream]

​Thanks for all this.

Edward