Package: pexdoc
DescriptionThis package provides a light framework that can be used to automatically
generate exceptions documentation marked up inreStructuredText.The exdoc module details how to register exceptions, how to traced them and
how to generate their documentationInterpreterThe package has been developed and tested with Python 2.7, 3.5, 3.6 and 3.7
under Linux (Debian, Ubuntu), Apple macOS and Microsoft WindowsInstalling$pipinstallpexdocDocumentationAvailable atRead the DocsContributingAbide by the adoptedcode of conductFork therepositoryfrom GitHub and
then clone personal copy[1]:$github_user=myname$gitclone--recurse-submodules\https://github.com/"${github_user}"/pexdoc.gitCloning into 'pexdoc'...
...$cdpexdoc||exit1$exportPEXDOC_DIR=${PWD}$The package uses two sub-modules: a set of custom Pylint plugins to help with
some areas of code quality and consistency (under thepylint_pluginsdirectory), and a lightweight package management framework (under thepypkgdirectory). Additionally, thepre-commit frameworkis used to perform various pre-commit code
quality and consistency checks. To enable the pre-commit hooks:$cd"${PEXDOC_DIR}"||exit1$pre-commitinstallpre-commit installed at .../pexdoc/.git/hooks/pre-commit$Ensure that the Python interpreter can find the package modules
(update the$PYTHONPATHenvironment variable, or usesys.paths(),
etc.)$exportPYTHONPATH=${PYTHONPATH}:${PEXDOC_DIR}$Install the dependencies (if needed, done automatically by pip):Cog(2.5.1 or newer)Coverage(4.5.3 or newer)Decorator(4.4.0 or newer)Docutils(0.14 or newer)Funcsigs(1.0.2 or newer)Inline Syntax Highlight Sphinx Extension(0.2 or newer)Mock(2.0.0 or newer)Pmisc(1.5.8 or newer)Ptrie(1.1.6 or newer)Py.test(4.3.1 or newer)PyContracts(1.8.2 or newer)Pydocstyle(3.0.0 or newer)Pylint(Python 2.x: 1.9.4 or newer, Python 3.x: 2.3.1 or newer)Pytest-coverage(2.6.1 or newer)Pytest-pmisc(1.0.7 or newer)Pytest-xdist(optional, 1.26.1 or newer)ReadTheDocs Sphinx theme(0.4.3 or newer)Shellcheck Linter Sphinx Extension(1.0.8 or newer)Sphinx(1.8.5 or newer)Tox(3.7.0 or newer)Virtualenv(16.4.3 or newer)Implement a new feature or fix a bugWrite a unit test which shows that the contributed code works as expected.
Run the package tests to ensure that the bug fix or new feature does not
have adverse side effects. If possible achieve 100% code and branch
coverage of the contribution. Thorough package validation
can be done via Tox and Pytest:$PKG_NAME=pexdoctoxGLOB sdist-make: .../pexdoc/setup.py
py27-pkg create: .../pexdoc/.tox/py27
py27-pkg installdeps: -r.../pexdoc/requirements/tests_py27.pip, -r.../pexdoc/requirements/docs_py27.pip
...
  py27-pkg: commands succeeded
  py35-pkg: commands succeeded
  py36-pkg: commands succeeded
  py37-pkg: commands succeeded
  congratulations :)$Setuptoolscan also be used
(Tox is configured as its virtual environment manager):$PKG_NAME=pexdocpythonsetup.pytestsrunning tests
running egg_info
writing pexdoc.egg-info/PKG-INFO
writing dependency_links to pexdoc.egg-info/dependency_links.txt
writing requirements to pexdoc.egg-info/requires.txt
...
  py27-pkg: commands succeeded
  py35-pkg: commands succeeded
  py36-pkg: commands succeeded
  py37-pkg: commands succeeded
  congratulations :)$Tox (or Setuptools via Tox) runs with the following default environments:py27-pkg,py35-pkg,py36-pkgandpy37-pkg[3]. These use
the 2.7, 3.5, 3.6 and 3.7 interpreters, respectively, to test all code in
the documentation (both in Sphinx*.rstsource files and in
docstrings), run all unit tests, measure test coverage and re-build the
exceptions documentation. To pass arguments to Pytest (the test runner) use
a double dash (--) after all the Tox arguments, for example:$PKG_NAME=pexdoctox-epy27-pkg---n4GLOB sdist-make: .../pexdoc/setup.py
py27-pkg inst-nodeps: .../pexdoc/.tox/.tmp/package/1/pexdoc-1.1.2.zip
...
  py27-pkg: commands succeeded
  congratulations :)$Or use the-aSetuptools optional argument followed by a quoted
string with the arguments for Pytest. For example:$PKG_NAME=pexdocpythonsetup.pytests-a"-e py27-pkg -- -n 4"running tests
...
  py27-pkg: commands succeeded
  congratulations :)$There are other convenience environments defined for Tox[3]:py27-repl,py35-repl,py36-replandpy37-replrun the
Python 2.7, 3.5, 3.6 and 3.7 REPL, respectively, in the appropriate
virtual environment. Thepexdocpackage is pip-installed by Tox when
the environments are created.  Arguments to the interpreter can be
passed in the command line after a double dash (--).py27-test,py35-test,py36-testandpy37-testrun Pytest
using the Python 2.7, 3.5, 3.6 and 3.7 interpreter, respectively, in the
appropriate virtual environment. Arguments to pytest can be passed in
the command line after a double dash (--) , for example:$PKG_NAME=pexdoctox-epy27-test---xtest_pexdoc.pyGLOB sdist-make: .../pexdoc/setup.py
py27-pkg inst-nodeps: .../pexdoc/.tox/.tmp/package/1/pexdoc-1.1.2.zip
...
  py27-pkg: commands succeeded
  congratulations :)$py27-test,py35-test,py36-testandpy37-testtest code
and branch coverage using the 2.7, 3.5, 3.6 and 3.7 interpreter,
respectively, in the appropriate virtual environment. Arguments to
pytest can be passed in the command line after a double dash (--).
The report can be found in${PEXDOC_DIR}/.tox/py[PV]/usr/share/pexdoc/tests/htmlcov/index.htmlwhere[PV]stands for2.7,3.5,3.6or3.7depending on the interpreter used.Verify that continuous integration tests pass. The package has continuous
integration configured for Linux, Apple macOS and Microsoft Windows (all viaAzure DevOps).Document the new feature or bug fix (if needed). The script${PEXDOC_DIR}/pypkg/build_docs.pyre-builds the whole package
documentation (re-generates images, cogs source files, etc.):$"${PEXDOC_DIR}"/pypkg/build_docs.py-husage: build_docs.py [-h] [-d DIRECTORY] [-r]
                     [-n NUM_CPUS] [-t]

Build pexdoc package documentation

optional arguments:
  -h, --help            show this help message and exit
  -d DIRECTORY, --directory DIRECTORY
                        specify source file directory
                        (default ../pexdoc)
  -r, --rebuild         rebuild exceptions documentation.
                        If no module name is given all
                        modules with auto-generated
                        exceptions documentation are
                        rebuilt
  -n NUM_CPUS, --num-cpus NUM_CPUS
                        number of CPUs to use (default: 1)
  -t, --test            diff original and rebuilt file(s)
                        (exit code 0 indicates file(s) are
                        identical, exit code 1 indicates
                        file(s) are different)Footnotes[1]All examples are for thebashshell[2]It is assumed that all the Python interpreters are in the executables
path. Source code for the interpreters can be downloaded from Python’s mainsite[3](1,2)Tox configuration largely inspired byIonel’s codelogLicenseThe MIT License (MIT)Copyright (c) 2013-2019 Pablo Acosta-SerafiniPermission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
.. CHANGELOG.rst
.. Copyright (c) 2013-2019 Pablo Acosta-Serafini
.. See LICENSE for detailsChangelog1.1.4 [2019-03-21]: Dependency fix1.1.3 [2019-03-21]: Dependency update1.1.2 [2019-03-21]: Documentation and dependency update1.1.1 [2019-03-04]: Updated package management framework1.1.0 [2018-01-19]: Dropped support for Python interpreter versions 2.6, 3.3
and 3.4. Updated dependencies versions to their current versions1.0.9 [2017-02-10]: Package build enhancements and fixes1.0.8 [2017-02-07]: Python 3.6 support1.0.7 [2017-01-02]: Suppressed deprecation warnings for
Python 2.61.0.6 [2016-06-13]: Fixed Windows continuous integration
failure1.0.5 [2016-06-11]: Minor documentation build bug fix1.0.4 [2016-05-13]: Documentation update1.0.3 [2016-05-11]: Documentation update1.0.2 [2016-05-11]: Documentation update1.0.1 [2016-05-11]: Documentation update1.0.0 [2016-05-01]: Final release of 1.0.0 branch1.0.0rc1 [2016-05-01]: Initial commit, forked a subset from putil PyPI
package