dirty: init

This commit is contained in:
Tiara Rodney 2025-06-06 22:41:37 +02:00
parent 19813d4d45
commit a5776f8e4b
No known key found for this signature in database
GPG key ID: 5F43FAB4FBE5B5EB
17 changed files with 173 additions and 31 deletions

View file

@ -12,7 +12,7 @@ via pip (PyPi)
.. code-block::
$> python3 -m pip install byteb4rb1ie-sphinxcontrib
$> python3 -m pip install byteb4rb1e-sphinxcontrib
via pip (Git)
-------------
@ -21,20 +21,6 @@ via pip (Git)
$> python3 -m pip git+https://bitbucket.org/byteb4rb1e/sphinxcontrib@master
via Git
-------
.. code-block::
$> git clone https://bitbucket.org/byteb4rb1e/sphinxcontrib
with pipenv
~~~~~~~~~~~
.. code-block::
$> sh ./configure --with-pipenv .pipenv
Usage
=====
@ -42,5 +28,140 @@ Usage
:caption: Sphinx Extensions
authorship
svc_authorship
authorship_svc
svc
Installation (Development)
==========================
.. code-block::
$> git clone https://bitbucket.org/byteb4rb1e/sphinxcontrib
.. warning::
(Non-MSYS2) Windows users MUST use ``.venv/Scripts/python3.exe``, instead of
``.venv/bin/python3``
.. warning::
(Non-MSYS2) Windows users MUST execute ``python3 -m pipenv install -d
--skip-lock``, instead of ``sh ./configure``.
with pipenv
-----------
``pipenv`` expected to be installed system-wide
.. code-block::
$> sh ./configure
with venv
---------
.. code-block::
$> python3 -m venv --system-site-packages .venv
$> .venv/bin/python3 -m pip install pipenv
$> .venv/bin/python3 -m pipenv run sh ./configure
with venv (but without configuration)
-------------------------------------
.. code-block::
$> python3 -m venv --system-site-packages .venv
$> .venv/bin/python3 -m pip install -r requirements-dev.txt
Development
===========
Static Code Analysis
--------------------
.. code-block::
$> python3 -m pipenv run test-static
Audit
~~~~~
.. code-block::
$> python3 -m tox -e audit
Format
~~~~~~
.. code-block::
$> python3 -m tox -e format -- --inline
Lint
~~~~
.. code-block::
$> python3 -m tox -e lint
Unit Testing
------------
.. code-block::
$> python3 -m pipenv run test-unit
Test Suite
~~~~~~~~~~
.. code-block::
$> python3 -m pipenv run test-unit -- -p tests/unit
Test Case
~~~~~~~~~
.. code-block::
$> python3 -m pipenv run test-unit -- -p tests/unit
Integration Testing
-------------------
.. code-block::
$> python3 -m pipenv run test-integration
Test Suite
~~~~~~~~~~
.. code-block::
$> python3 -m pipenv run test-integration -- \
-p tests/integration/byteb4rb1e_sphinxcontrib/authorship
Test Case
~~~~~~~~~
.. code-block::
$> python3 -m pipenv run test-integration -- \
-p tests/integration/byteb4rb1e_sphinxcontrib/authorship/test_setup.py
with a definitive Python and Sphinx major version (e.g. *Python* ``3.10``, and *Sphinx*
``6``)
.. code-block::
$> python3 -m tox -e py310-sphinx6-integration -- \
-p tests/unit
Documentation
-------------
.. code-block::
$> python3 -m pipenv run doc