Skip to content

tox: update doc build commands #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/command_ref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ installed.
* :ref:`scripts-postmkvirtualenv`
* `requirements file format`_

.. _requirements file format: https://pip.pypa.io/en/latest/reference/pip_install/#requirements-file-format
.. _requirements file format: https://pip.pypa.io/en/stable/reference/requirements-file-format/

.. _command-mktmpenv:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/developers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ the ``tests`` directory.

.. _shunit2: https://github.com/kward/shunit2

.. _tox: https://tox.testrun.org/
.. _tox: https://tox.wiki/

.. _developer-templates:

Expand Down
5 changes: 2 additions & 3 deletions docs/source/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -186,8 +186,7 @@ used).

.. seealso::

* `namespace packages <https://setuptools.readthedocs.io/en/latest/setuptools.html#namespace-packages>`__
* `Extensible Applications and Frameworks <https://setuptools.readthedocs.io/en/latest/setuptools.html#extensible-applications-and-frameworks>`__
* `namespace packages <https://packaging.python.org/en/latest/guides/packaging-namespace-packages/>`__

The Hook Loader
---------------
Expand Down Expand Up @@ -257,7 +256,7 @@ messages.
.. seealso::

* `Standard library documentation for logging <https://docs.python.org/library/logging.html>`__
* `PyMOTW for logging <https://www.doughellmann.com/PyMOTW/logging/>`__
* `PyMOTW for logging <http://pymotw.com/3/logging/>`__

.. _plugins-extension-points:

Expand Down
10 changes: 3 additions & 7 deletions docs/source/tips.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ While the virtualenv ``activate`` script does attempt to provide
an indicator in the prompt, it has various shortcomings, and
cannot be customized.

However, it does also set a shell variable named
However, it does also set a shell variable named
``VIRTUAL_ENV`` which can be used as the basis for disabling the
built-in prompt indicator and substituting an improved one,
as a customization to ``.bashrc`` or ``.zshrc``::

virtualenv_prompt() {
# If not in a virtualenv, print nothing
[[ "$VIRTUAL_ENV" == "" ]] && return

# Distinguish between the shell where the virtualenv was activated
# and its children
local venv_name="${VIRTUAL_ENV##*/}"
Expand All @@ -37,7 +37,7 @@ as a customization to ``.bashrc`` or ``.zshrc``::
echo "<${venv_name}> "
fi
}

# Display a "we are in a virtualenv" indicator that works in child shells too
VIRTUAL_ENV_DISABLE_PROMPT=1
PS1='$(virtualenv_prompt)'"$PS1"
Expand Down Expand Up @@ -116,10 +116,6 @@ directory each time he runs ``cd``. If it finds a ``.venv`` file, it
activates the environment named within. On leaving that directory,
the current virtualenv is automatically deactivated.

`Harry Marr <http://hmarr.com/about/>`__
wrote a similar function that works with `git repositories
<http://hmarr.com/2010/jan/19/making-virtualenv-play-nice-with-git/>`__.

Installing Common Tools Automatically in New Environments
=========================================================

Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ classifier =
Programming Language :: Python :: 3.9
Programming Language :: Python :: 3.10
Programming Language :: Python :: 3.11
Intended Audience :: Developers
Intended Audience :: Developers
Environment :: Console
keywords =
virtualenv
Expand Down
4 changes: 3 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ commands = ksh ./tests/run_tests {envdir} []
deps =
-r{toxinidir}/requirements.txt
-r{toxinidir}/docs/requirements.txt
commands = python setup.py build_sphinx
commands =
sphinx-build -W -j auto -b html -d docs/build/doctrees docs/source docs/build/html
sphinx-build -W -j auto -b linkcheck -d docs/build/doctrees docs/source docs/build/linkcheck

[testenv:pkglint]
deps=
Expand Down