Skip to content
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

Remove makefile, add build_docs command to tox.ini #1240

Merged
merged 1 commit into from
Feb 15, 2024
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
32 changes: 0 additions & 32 deletions Makefile

This file was deleted.

15 changes: 8 additions & 7 deletions docs/contribute/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,17 @@ Before opening a new Pull Request, please ensure the linter and at least platfor
Requirements
============

Tests should be run using `tox <https://tox.wiki/en/latest/>`_
Development environments are managed using `tox <https://tox.wiki/en/latest/>`_

Install tox from the command line:
Generally, tox should be installed with pip:

.. highlight:: bash

::

pip install tox

See tox's documentation if you need to use another method.

Linter
======
Expand Down Expand Up @@ -99,14 +100,14 @@ We use the `Read the Docs Sphinx Theme <https://sphinx-rtd-theme.readthedocs.io/
Build
-----

In order to build the HTML docs, navigate to the project folder
(the main folder, not the ``docs`` folder) and run the following command:
The `build_docs` environment is a wrapper around Sphinx's Makefile.
Arguments will be passed to the Makefile. Thus, to build the docs in HTML format:

.. highlight:: bash

::

$ make doc
tox -e build_docs html

The requirements for building the docs are specified in
``requirements/docs.txt`` in the project folder.

The documentation will then be built inside the `docs/_build` directory.
19 changes: 13 additions & 6 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -1,30 +1,37 @@
[testenv:tests]
extras = zope.testbrowser, django, flask
deps = -rrequirements/test.txt
commands=
commands =
pytest --ignore-flaky -v {posargs}


[testenv:tests_selenium]
extras = selenium
deps =
-rrequirements/test.txt
commands=
commands =
pytest --ignore-flaky -m "not macos" -v {posargs}


[testenv:tests_windows_selenium]
extras = selenium
deps =
-rrequirements\test_windows.txt
passenv =
EDGEWEBDRIVER
commands=
commands =
pytest --ignore-flaky -v {posargs}

[testenv:tests_macos_selenium]
extras = selenium
deps =
-rrequirements/test.txt
commands=
commands =
pytest --ignore-flaky -m macos -v {posargs}

[testenv:build_docs]
allowlist_externals = make
deps =
-rrequirements/doc.txt
changedir = docs/
commands =
make clean
make {posargs}
Loading