Skip to content

Commit e9d55ae

Browse files
committed
docs: adjust developing.rst
1 parent 816817d commit e9d55ae

1 file changed

Lines changed: 46 additions & 27 deletions

File tree

‎doc/developing.rst‎

Lines changed: 46 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -54,19 +54,19 @@ install the `pre-commit hook`_ for Black integration before committing::
5454
Running the tests
5555
-----------------
5656

57-
You can run the tests using `py.test`_::
57+
You can run the tests using `pytest`_::
5858

59-
$ py.test
59+
$ pytest
6060

6161
To generate test coverage information as HTML do::
6262

63-
$ py.test --cov --cov-report html
63+
$ pytest --cov --cov-report html
6464

6565
You can then point your web browser to the ``htmlcov/index.html`` file
6666
in the project directory and click on modules to see detailed coverage
6767
information.
6868

69-
.. _`py.test`: https://pytest.org/latest/
69+
.. _`pytest`: https://pytest.org
7070

7171
Black
7272
-----
@@ -80,27 +80,11 @@ Black has also integration_ for the most popular editors.
8080
.. _`Black Code Formatter`: https://black.readthedocs.io
8181
.. _integration: https://black.readthedocs.io/en/stable/editor_integration.html
8282

83-
Building the HTML documentation
84-
-------------------------------
85-
86-
To build the HTML documentation (output in ``doc/build/html``), run::
87-
88-
$ sphinx-build doc doc/build/html
89-
90-
Or alternatively if you have ``Make`` installed::
91-
92-
$ cd doc
93-
$ make html
94-
95-
Or from the Importscan project directory::
96-
97-
$ make -C doc html
98-
99-
Various checking tools
100-
----------------------
83+
flake8
84+
------
10185

10286
flake8_ is a tool that can do various checks for common Python
103-
mistakes using pyflakes_, check for PEP8_ style compliance and
87+
mistakes using pyflakes_, checks for PEP8_ style compliance and
10488
can do `cyclomatic complexity`_ checking. To do pyflakes and pep8
10589
checking do::
10690

@@ -118,21 +102,56 @@ To also show cyclomatic complexity, use this command::
118102

119103
.. _`cyclomatic complexity`: https://en.wikipedia.org/wiki/Cyclomatic_complexity
120104

105+
106+
Running the documentation tests
107+
-------------------------------
108+
109+
The documentation contains code. To check these code snippets, you
110+
can run this code using this command::
111+
112+
(py3) $ sphinx-build -b doctest doc doc/build/doctest
113+
114+
Or alternatively if you have ``Make`` installed::
115+
116+
(py3) $ cd doc
117+
(py3) $ make doctest
118+
119+
Or from the Dectate project directory::
120+
121+
(py3) $ make -C doc doctest
122+
123+
Building the HTML documentation
124+
-------------------------------
125+
126+
To build the HTML documentation (output in ``doc/_build/html``), run::
127+
128+
$ sphinx-build doc doc/_build/html
129+
130+
Or alternatively if you have ``Make`` installed::
131+
132+
$ cd doc
133+
$ make html
134+
135+
Or from the Dectate project directory::
136+
137+
$ make -C doc html
138+
121139
Tox
122140
---
123141

124-
With tox you can test Morepath under different Python environments.
142+
With tox you can test Importscan under different Python environments.
125143

126-
We have Travis continuous integration installed on Morepath's github
144+
We have gh-actions continuous integration installed on Importscan's github
127145
repository and it runs the same tox tests after each checkin.
128146

129147
First you should install all Python versions which you want to
130148
test. The versions which are not installed will be skipped. You should
131-
at least install Python 3.7 which is required by flake8 and coverage tests.
149+
at least install Python 3.14 which is required by flake8, coverage,
150+
doctests, mypy and pyright.
132151

133152
One tool you can use to install multiple versions of Python is pyenv_.
134153

135-
To find out which test environments are defined for Morepath in tox.ini run::
154+
To find out which test environments are defined for Importscan in tox.ini run::
136155

137156
$ tox -l
138157

0 commit comments

Comments
 (0)