Debian Codegraph @

docs/index.rst

raw
1 #####
2 tox
3 #####
4
5 .. image:: https://img.shields.io/pypi/v/tox?style=flat-square
6 :target: https://pypi.org/project/tox/#history
7 :alt: Latest version on PyPI
8
9 .. image:: https://img.shields.io/pypi/implementation/tox?style=flat-square
10 :alt: PyPI - Implementation
11
12 .. image:: https://img.shields.io/pypi/pyversions/tox?style=flat-square
13 :alt: PyPI - Python Version
14
15 .. image:: https://readthedocs.org/projects/tox/badge/?version=latest&style=flat-square
16 :target: https://tox.wiki/en/latest/
17 :alt: Documentation status
18
19 .. image:: https://img.shields.io/discord/802911963368783933?style=flat-square
20 :target: https://discord.com/invite/tox
21 :alt: Discord
22
23 .. image:: https://img.shields.io/pypi/dm/tox?style=flat-square
24 :target: https://pypistats.org/packages/tox
25 :alt: PyPI - Downloads
26
27 .. image:: https://img.shields.io/pypi/l/tox?style=flat-square
28 :target: https://opensource.org/license/mit
29 :alt: PyPI - License
30
31 .. image:: https://img.shields.io/github/issues/tox-dev/tox?style=flat-square
32 :target: https://github.com/tox-dev/tox/issues
33 :alt: Open issues
34
35 .. image:: https://img.shields.io/github/issues-pr/tox-dev/tox?style=flat-square
36 :target: https://github.com/tox-dev/tox/pulls
37 :alt: Open pull requests
38
39 .. image:: https://img.shields.io/github/stars/tox-dev/tox?style=flat-square
40 :target: https://pypistats.org/packages/tox
41 :alt: Package popularity
42
43 tox is a generic virtual environment management and test command line tool you can use for:
44
45 - checking your package builds and installs correctly under different environments (such as different Python
46 implementations, versions or installation dependencies),
47 - running your tests in each of the environments with the test tool of choice,
48 - acting as a frontend to continuous integration servers, greatly reducing boilerplate and merging CI and shell-based
49 testing.
50
51 ******************
52 Quick navigation
53 ******************
54
55 **Tutorial** - Learn by doing
56
57 - :doc:`tutorial/getting-started` — Create your first tox environment and learn the basic workflow
58
59 **How-to guides** - Solve specific problems
60
61 - :doc:`how-to/install` — Install tox on your system
62 - :doc:`how-to/usage` — Common tasks and workflows with tox
63
64 **Reference** - Technical information
65
66 - :doc:`reference/config` — Complete configuration reference
67 - :doc:`reference/cli` — Command line interface options
68
69 **Explanation** - Understand the concepts
70
71 - :doc:`explanation` — How tox works, architecture, and design principles
72
73 **Extensions**
74
75 - :doc:`plugin/index` — Extend tox with custom plugins
76
77 ***************
78 Presentations
79 ***************
80
81 Learn more about tox from maintainer presentations:
82
83 - `Oliver Bestwalter - Automating Build, Test and Release Workflows with tox
84 <https://www.youtube.com/watch?v=PrAyvH-tm8E>`_
85 - `Bernat Gabor - Standardize Testing in Python <https://www.youtube.com/watch?v=SFqna5ilqig>`_
86
87 .. toctree::
88 :hidden:
89 :caption: Tutorial
90
91 tutorial/getting-started
92
93 .. toctree::
94 :hidden:
95 :caption: How-to guides
96
97 how-to/install
98 how-to/usage
99
100 .. toctree::
101 :hidden:
102 :caption: Reference
103
104 reference/config
105 reference/cli
106
107 .. toctree::
108 :hidden:
109 :caption: Explanation
110
111 explanation
112
113 .. toctree::
114 :hidden:
115 :caption: Extend
116
117 plugin/index
118
119 .. toctree::
120 :hidden:
121 :caption: Project
122
123 development
124 changelog