Skip to content

Commit

Permalink
Minor doc improvements
Browse files Browse the repository at this point in the history
Details:

* Simplified the Installation section by merging a subchapter into the
  Installation chapter.

* Corrected the set of tested OS environments to no longer contain CygWin.

* Removed the prerequisites packages setuptools, pip and wheel for installation,
  since pip does not have any requirements on setuptools or wheel.

* Removed the "Python namespace" section and moved the statement about
  describing only the external API to the begin of the "API Reference"
  section.

* Specified language 'en' for the docs building in conf.py, to eliminate
  a corresponding warning during docs building.

* Generalized the version 3.4 to 3 in teh link to the Python 3 glossary.

Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>
  • Loading branch information
andy-maier committed Jan 7, 2023
1 parent 1afae80 commit 7dbfe47
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 54 deletions.
2 changes: 1 addition & 1 deletion docs/appendix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ References

Python Glossary
* `Python 2.7 Glossary <https://docs.python.org/2.7/glossary.html>`_
* `Python 3.4 Glossary <https://docs.python.org/3.4/glossary.html>`_
* `Python 3 Glossary <https://docs.python.org/3/glossary.html>`_
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ def get_version(version_file):
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = 'en'

# By default, highlight as Python 3.
highlight_language = 'python3'
Expand Down
70 changes: 18 additions & 52 deletions docs/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,11 @@ Supported environments
^^^^^^^^^^^^^^^^^^^^^^

The package does not have any dependencies on the type of operating system and
is regularly tested in CI systems on the following operating systems:
is regularly tested in GitHub Actions on the following operating systems:

* Ubuntu, native Windows, CygWin, OS-X / macOS
* Ubuntu, Windows, macOS

The package is supported on the following Python versions:
The package is supported and tested on the following Python versions:

* Python: 2.7, 3.4 and all higher 3.x versions

Expand All @@ -79,55 +79,31 @@ The package is supported on the following Python versions:
Installing
^^^^^^^^^^

* Prerequisites:
The following command installs the latest version of nocasedict that is
released on `PyPI`_ into the active Python environment:

- The Python environment into which you want to install must be the current
Python environment, and must have at least the following Python packages
installed:

- setuptools
- wheel
- pip

* Install the nocasedict package and its prerequisite
Python packages into the active Python environment:

.. code-block:: bash
$ pip install nocasedict
.. _`Installing a different version`:

Installing a different version
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: bash
The examples in the previous sections install the latest version of
nocasedict that is released on `PyPI`_.
This section describes how different versions of nocasedict
can be installed.
$ pip install nocasedict
* To install an older released version of nocasedict,
Pip supports specifying a version requirement. The following example installs
nocasedict version 0.1.0
from PyPI:
To install an older released version of nocasedict, Pip supports specifying a
version requirement. The following example installs nocasedict version 0.1.0
from PyPI into the active Python environment:

.. code-block:: bash
.. code-block:: bash
$ pip install nocasedict==0.1.0
$ pip install nocasedict==0.1.0
* If you need to get a certain new functionality or a new fix that is
not yet part of a version released to PyPI, Pip supports installation from a
Git repository. The following example installs nocasedict
from the current code level in the master branch of the
`nocasedict repository`_:
If you need to get a certain new functionality or a new fix that is not yet part
of a version released to PyPI, Pip supports installation from a Git repository.
The following example installs nocasedict from the current code level in the
master branch of the `nocasedict repository`_:

.. code-block:: bash
.. code-block:: bash
$ pip install git+https://github.com/pywbem/nocasedict.git@master#egg=nocasedict
$ pip install git+https://github.com/pywbem/nocasedict.git@master#egg=nocasedict
.. _nocasedict repository: https://github.com/pywbem/nocasedict

.. _PyPI: https://pypi.python.org/pypi


Expand Down Expand Up @@ -228,13 +204,3 @@ the nocasedict project, by version type:
* New major release (M.N.P -> M+1.0.0): Deprecated functionality may get
removed; functionality may be extended or changed; backwards compatibility
may be broken.


.. _'Python namespaces`:

Python namespaces
-----------------

This documentation describes only the external APIs of the
nocasedict project, and omits any internal symbols and
any sub-modules.
3 changes: 3 additions & 0 deletions docs/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
API Reference
=============

This section describes the external API of the nocasedict project. Any
internal symbols and APIs are omitted.


.. _`Class NocaseDict`:

Expand Down

0 comments on commit 7dbfe47

Please sign in to comment.