summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorUlf Magnusson <ulfalizer@gmail.com>2018-10-02 01:15:35 +0200
committerUlf Magnusson <ulfalizer@gmail.com>2018-10-02 01:16:39 +0200
commit08abf4478eafbab7c30e6d147a9578e964173b83 (patch)
tree373d4d32426d20d52a76a2cab5c57a5324451219 /README.rst
parent6aaf01c241b1356c1c8ceb3425f355f448bb4224 (diff)
Mention that pydoc works after installing with pip
Also mention that menuconfig.py has documentation.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst25
1 files changed, 17 insertions, 8 deletions
diff --git a/README.rst b/README.rst
index 9134c3f..dd44723 100644
--- a/README.rst
+++ b/README.rst
@@ -109,21 +109,30 @@ the following command:
.. code:: sh
- $ pydoc kconfiglib
+ $ pydoc(3) kconfiglib
For HTML output, add ``-w``:
.. code:: sh
- $ pydoc -w kconfiglib
+ $ pydoc(3) -w kconfiglib
-A good starting point is to read the module docstring (which you could also just read directly
-at the beginning of `kconfiglib.py <https://github.com/ulfalizer/Kconfiglib/blob/master/kconfiglib.py>`_). It gives an introduction to symbol
-values, the menu tree, and expressions.
+This will also work after installing Kconfiglib with ``pip(3)``.
-After reading the module docstring, a good next step is to read the ``Kconfig`` class
-documentation, and then the documentation for the ``Symbol``, ``Choice``, and ``MenuNode``
-classes.
+Documentation for the ``menuconfig`` interface can be viewed in the same way:
+
+.. code:: sh
+
+ $ pydoc3 menuconfig
+
+A good starting point for learning the library is to read the module docstring
+(which you could also just read directly at the beginning of `kconfiglib.py
+<https://github.com/ulfalizer/Kconfiglib/blob/master/kconfiglib.py>`_). It
+gives an introduction to symbol values, the menu tree, and expressions.
+
+After reading the module docstring, a good next step is to read the ``Kconfig``
+class documentation, and then the documentation for the ``Symbol``, ``Choice``,
+and ``MenuNode`` classes.
Please tell me if something is unclear or can be explained better.