Merge pull request #189 from nicolasbock/nicolasbock-patch-1

Update CONTRIBUTING.rst

Author: nicolasbock

.github/workflows/build.yaml

@@ -37,7 +37,7 @@ jobs:
         python_version: ${{ matrix.python-version }}
 
     - name: Check out sources
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
       with:
         fetch-depth: 0
 

CONTRIBUTING.rst

@@ -1,8 +1,8 @@
 Developer Documentation
 =======================
 
-This project supports Python 3.8, 3.9, and 3.10. Other Python versions might
-work as well but are not regularly tested.
+This project supports Python 3.6, 3.7, 3.8, 3.9, and 3.10. Other Python versions
+might work as well but are not regularly tested.
 
 For locally testing changes it is very handy to install `tox` which automates
 the creation of Python virtual environments.
@@ -11,6 +11,7 @@ Dependencies
 ------------
 
 - `docker`
+- `fuse`
 
 Setting up a developer environment
 ----------------------------------

README.rst

@@ -44,14 +44,14 @@ Usage
 
 We are going to assume that the user has a local git clone of the portage tree in
 
-.. code-block:: bash
+.. code-block:: console
 
    /usr/local/git/gentoo
 
 We have added a new ebuild and would like to verify that the build
 dependencies are all correct. We can build the package (ATOM) with:
 
-.. code-block:: bash
+.. code-block:: console
 
    ebuildtester --portage-dir /usr/local/git/gentoo \
      --atom ATOM \
@@ -68,7 +68,7 @@ Command line arguments
 
 The command understands the following command line arguments:
 
-.. code-block:: bash
+.. code-block:: console
 
    usage: ebuildtester [-h] [--version] [--atom ATOM [ATOM ...]] [--binhost BINHOST] [--live-ebuild]
                        [--manual] --portage-dir PORTAGE_DIR [--overlay-dir OVERLAY_DIR] [--update]
@@ -116,3 +116,9 @@ The command understands the following command line arguments:
      --docker-image DOCKER_IMAGE
                            Specify the docker image to use (default = gentoo/stage3)
      --pull                Download latest docker image
+
+Developer Instructions
+----------------------
+
+For more information and how to contribute to this project see the
+:doc:`Contributing <contributing>` page.

docs/conf.py

@@ -52,7 +52,7 @@
 
 # General information about the project.
 project = 'ebuildtester'
-copyright = '2018, Nicolas Bock'
+copyright = '2018-2022, Nicolas Bock'
 author = 'Nicolas Bock'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -69,7 +69,7 @@
 #
 # 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'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

docs/contributing.rst

@@ -0,0 +1,5 @@
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+.. include:: ../CONTRIBUTING.rst

docs/ebuildtester.rst

@@ -4,51 +4,58 @@ ebuildtester package
 Submodules
 ----------
 
-ebuildtester\.docker module
----------------------------
+ebuildtester.atom module
+------------------------
+
+.. automodule:: ebuildtester.atom
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ebuildtester.docker module
+--------------------------
 
 .. automodule:: ebuildtester.docker
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
-ebuildtester\.main module
--------------------------
+ebuildtester.main module
+------------------------
 
 .. automodule:: ebuildtester.main
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
-ebuildtester\.options module
-----------------------------
+ebuildtester.options module
+---------------------------
 
 .. automodule:: ebuildtester.options
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
-ebuildtester\.parse module
---------------------------
+ebuildtester.parse module
+-------------------------
 
 .. automodule:: ebuildtester.parse
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
-ebuildtester\.utils module
---------------------------
+ebuildtester.utils module
+-------------------------
 
 .. automodule:: ebuildtester.utils
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Module contents
 ---------------
 
 .. automodule:: ebuildtester
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/index.rst

@@ -1,5 +1,9 @@
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+   :numbered:
+
+   ../README.rst
+   contributing.rst
+   ebuildtester.rst
 
 .. include:: ../README.rst

tox.ini

@@ -14,10 +14,10 @@ commands =
 [testenv:docs]
 commands =
          sphinx-apidoc --force --output-dir docs ebuildtester
+         sphinx-build -M html docs docs/_build
          sphinx-build -M doctest docs docs/_build
          sphinx-build -M linkcheck docs docs/_build
          sphinx-build -M coverage docs docs/_build
-         sphinx-build -M html docs docs/_build
          sphinx-build -M man docs docs/_build
 
 [testenv:bandit]