python-Sphinx
Port variant py38
Summary Python documentation generator (PY38)
Package version 4.2.0
Homepage https://www.sphinx-doc.org/
Keywords python
Maintainer Python Automaton
License Not yet specified
Other variants py39
Ravenports Buildsheet | History
Ravensource Port Directory | History
Last modified 14 SEP 2021, 23:34:25 UTC
Port created 20 APR 2017, 05:12:41 UTC
Subpackage Descriptions
single ======== Sphinx ======== :alt: Package on PyPI :alt: Documentation Status :alt: Build Status (AppVeyor) :alt: Build Status (CircleCI) :alt: Code Coverage Status (Codecov) :alt: BSD 3 Clause :alt: Open Source Helpers badge Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText sources), written by Georg Brandl. It was originally created for the new Python documentation, and has excellent facilities for Python project documentation, but C/C++ is supported as well, and more languages are planned. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils. Among its features are the following: * Output formats: HTML (including derivative formats such as HTML Help, Epub and Qt Help), plain text, manual pages and LaTeX or direct PDF output using rst2pdf * Extensive cross-references: semantic markup and automatic links for functions, classes, glossary terms and similar pieces of information * Hierarchical structure: easy definition of a document tree, with automatic links to siblings, parents and children * Automatic indices: general index as well as a module index * Code handling: automatic highlighting using the Pygments highlighter * Flexible HTML output using the Jinja 2 templating engine * Various extensions are available, e.g. for automatic testing of snippets and inclusion of appropriately formatted docstrings * Setuptools integration For more information, refer to the `the documentation`__. .. __: http://www.sphinx-doc.org/ Installation ============ Sphinx is published on `PyPI`__ and can be installed from there:: pip install -U sphinx We also publish beta releases:: pip install -U --pre sphinx If you wish to install `Sphinx` for development purposes, refer to `the contributors guide`__. __ https://pypi.org/project/Sphinx/ __ http://www.sphinx-doc.org/en/master/internals/contributing.html Documentation ============= Documentation is available from `sphinx-doc.org`__. __ http://www.sphinx-doc.org/ Get in touch ============ - Report bugs, suggest features or view the source code `on GitHub`_. - For less well defined questions or ideas, use the `mailing list`_. .. _on GitHub: https://github.com/sphinx-doc/sphinx .. _mailing list: https://groups.google.com/forum/#!forum/sphinx-users Please adhere to our `code of conduct`__. __ http://www.sphinx-doc.org/en/master/code_of_conduct.html Testing ======= Continuous testing is provided by `Travis`__ (for unit tests and style checks on Linux), `AppVeyor`__ (for unit tests on Windows), and `CircleCI`__ (for large processes like TeX compilation).
Configuration Switches (platform-specific settings discarded)
PY38 ON Build using Python 3.8 PY39 OFF Build using Python 3.9
Package Dependencies by Type
Build (only) python-pip:single:py38
autoselect-python:single:standard
Build and Runtime python38:single:standard
Runtime (only) python-sphinxcontrib-applehelp:single:py38
python-sphinxcontrib-devhelp:single:py38
python-sphinxcontrib-jsmath:single:py38
python-sphinxcontrib-htmlhelp:single:py38
python-sphinxcontrib-serializinghtml:single:py38
python-sphinxcontrib-qthelp:single:py38
python-Jinja2:single:py38
python-Pygments:single:py38
python-docutils:single:py38
python-snowballstemmer:single:py38
python-Babel:single:py38
python-alabaster:single:py38
python-imagesize:single:py38
python-requests:single:py38
python-setuptools:single:py38
python-packaging:single:py38
python-colorama:single:py38
Download groups
main mirror://PYPIWHL/00/08/c037fa5d3794729fdc7967e5a174642c8e94e1988ae2bc950515e2902ca2
Distribution File Information
98a535c62a4fcfcc362528592f69b26f7caec587d32cd55688db580be0287ae0 3061858 Sphinx-4.2.0-py3-none-any.whl
Ports that require python-Sphinx:py38
asis:standard Ada Semantic Interface Specification (GNAT)
aws:standard Adacore Ada Web Server and framework
cmake:standard Cross-platform Makefile generator
gtkada:standard Ada graphical toolkit based on Gtk3 components
libcxx:standard LLVM C++ standard library
libtcod:standard Roguelike game development library
python-breathe:py38 Sphinx Doxygen renderer (PY38)
python-recommonmark:py38 Docutils-compatibility bridge to CommonMark (PY38)
python-sphinx-rtd-theme:py38 Read the Docs theme for Sphinx (PY38)
python-sphinxcontrib-adadomain:py38 Sphinx "adadomain" extension (PY38)
qemu:standard Fast CPU emulator and virtualizer for x86 platform