Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
S
setuptools
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Jérome Perrin
setuptools
Commits
d11f10ed
Commit
d11f10ed
authored
May 14, 2018
by
Paul Ganssle
Committed by
GitHub
May 14, 2018
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #1352 from jmbowman/jmbowman/tox_docs
Add tox environment for docs
parents
09541d1e
d5648510
Changes
3
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
16 additions
and
5 deletions
+16
-5
.gitignore
.gitignore
+1
-0
docs/developer-guide.txt
docs/developer-guide.txt
+7
-5
tox.ini
tox.ini
+8
-0
No files found.
.gitignore
View file @
d11f10ed
...
@@ -2,6 +2,7 @@
...
@@ -2,6 +2,7 @@
bin
bin
build
build
dist
dist
docs/build
include
include
lib
lib
distribute.egg-info
distribute.egg-info
...
...
docs/developer-guide.txt
View file @
d11f10ed
...
@@ -106,10 +106,12 @@ Setuptools follows ``semver``.
...
@@ -106,10 +106,12 @@ Setuptools follows ``semver``.
Building Documentation
Building Documentation
----------------------
----------------------
Setuptools relies on the
Sphinx
system for building documentation.
Setuptools relies on the
`Sphinx`_
system for building documentation.
T
o accommodate RTD, docs must be built from the docs/ directory
.
T
he `published documentation`_ is hosted on Read the Docs
.
To build them, you need to have installed the requirements specified
To build the docs locally, use tox::
in docs/requirements.txt. One way to do this is to use rwt:
setuptools/docs$ python -m rwt -r requirements.txt -- -m sphinx . html
$ tox -e docs
.. _Sphinx: http://www.sphinx-doc.org/en/master/
.. _published documentation: https://setuptools.readthedocs.io/en/latest/
tox.ini
View file @
d11f10ed
...
@@ -33,6 +33,14 @@ deps=codecov
...
@@ -33,6 +33,14 @@ deps=codecov
skip_install
=
True
skip_install
=
True
commands
=
codecov --file {toxworkdir}/coverage.xml
commands
=
codecov --file {toxworkdir}/coverage.xml
[testenv:docs]
deps
=
-r{toxinidir}/docs/requirements.txt
skip_install
=
True
commands
=
python
{toxinidir}/bootstrap.py
sphinx-build
-b
html
-d
{envtmpdir}/doctrees
docs
docs/build/html
sphinx-build
-b
man
-d
{envtmpdir}/doctrees
docs
docs/build/man
[coverage:run]
[coverage:run]
source
=
source
=
pkg_resources
pkg_resources
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment