Skip to content

Commit 3c59f4a

Browse files
committed
Updated configuration files.
1 parent 141779e commit 3c59f4a

File tree

8 files changed

+32
-76
lines changed

8 files changed

+32
-76
lines changed

CONTRIBUTING.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Coding style
1919

2020
`Yapf <https://github.com/google/yapf>`_ is used for code formatting, and `isort <https://timothycrosley.github.io/isort/>`_ is used to sort imports.
2121

22-
``yapf`` and ``isort`` can be run via ``pre-commit``:
22+
``yapf`` and ``isort`` can be run manually via ``pre-commit``:
2323

2424
.. code-block:: bash
2525
@@ -65,7 +65,7 @@ Type annotations are checked using ``mypy``. Run ``mypy`` using ``tox``:
6565
Build documentation locally
6666
------------------------------
6767

68-
Documentation is powered by Sphinx. A local copy of the documentation can be built with ``tox``:
68+
The documentation is powered by Sphinx. A local copy of the documentation can be built with ``tox``:
6969

7070
.. code-block:: bash
7171

doc-source/Building.rst

Lines changed: 0 additions & 59 deletions
This file was deleted.

doc-source/Source.rst

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
*******************************
1+
=========================
22
Downloading source code
3-
*******************************
3+
=========================
44

5-
The ``domdf_python_tools`` source code resides on publicly accessible GitHub servers,
5+
The ``domdf_python_tools`` source code is available on GitHub,
66
and can be accessed from the following URL: https://github.com/domdfcoding/domdf_python_tools"
77

88
If you have ``git`` installed, you can clone the repository with the following command:
@@ -25,3 +25,17 @@ If you have ``git`` installed, you can clone the repository with the following c
2525
:alt: Downloading a 'zip' file of the source code.
2626
2727
Downloading a 'zip' file of the source code
28+
29+
30+
Building from source
31+
-----------------------
32+
33+
The recommended way to build ``domdf_python_tools`` is to use `tox <https://tox.readthedocs.io/en/latest/>`_:
34+
35+
.. prompt:: bash
36+
37+
tox -e build
38+
39+
The source and wheel distributions will be in the directory ``dist``.
40+
41+
If you wish, you may also use `pep517.build <https://pypi.org/project/pep517/>`_ or another :pep:`517`-compatible build tool.

doc-source/_static/style.css

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
/* This file is managed by 'repo_helper'. Don't edit it directly. */
22

3-
/* Body width */
4-
.wy-nav-content {max-width: 1200px !important;}
3+
.wy-nav-content {
4+
max-width: 1200px !important;
5+
}
56

6-
/* Spacing between list items */
7-
li p:last-child { margin-bottom: 12px !important;}
7+
li p:last-child {
8+
margin-bottom: 12px !important;
9+
}
810

9-
/* Smooth scrolling between sections */
1011
html {
11-
scroll-behavior: smooth;
12+
scroll-behavior: smooth;
1213
}

doc-source/contributing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Coding style
1919

2020
`Yapf <https://github.com/google/yapf>`_ is used for code formatting, and `isort <https://timothycrosley.github.io/isort/>`_ is used to sort imports.
2121

22-
``yapf`` and ``isort`` can be run via ``pre-commit``:
22+
``yapf`` and ``isort`` can be run manually via ``pre-commit``:
2323

2424
.. prompt:: bash
2525

@@ -65,7 +65,7 @@ Type annotations are checked using ``mypy``. Run ``mypy`` using ``tox``:
6565
Build documentation locally
6666
------------------------------
6767

68-
Documentation is powered by Sphinx. A local copy of the documentation can be built with ``tox``:
68+
The documentation is powered by Sphinx. A local copy of the documentation can be built with ``tox``:
6969

7070
.. prompt:: bash
7171

doc-source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,8 +165,8 @@ Installation
165165
:maxdepth: 3
166166
:caption: Documentation
167167

168+
contributing
168169
Source
169-
Building
170170

171171
.. start links
172172

make_conda_recipe.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/usr/bin/python3
22

3-
# This file is managed by `repo_helper`. Don't edit it directly
3+
# This file is managed by `repo_helper`. Don't edit it directly.
44

55
# stdlib
66
import platform

tox.ini

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ python =
2525

2626

2727
[testenv]
28+
setenv = PYTHONDEVMODE = 1
2829
# Install test requirements
2930
deps = -r{toxinidir}/tests/requirements.txt
3031
commands =
@@ -191,8 +192,7 @@ namespace_packages = True
191192
192193
193194
[coverage:run]
194-
plugins =
195-
coverage_pyver_pragma
195+
plugins = coverage_pyver_pragma
196196
197197
198198
[check-wheel-contents]

0 commit comments

Comments
 (0)