1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
===========
Development
===========
Code of Conduct
===============
.. include:: ../CODE_OF_CONDUCT.rst
Contribution Guideline
======================
.. include:: ../CONTRIBUTING.rst
Setup development environment
=============================
* Requires supported Python version
* Do setup under sphinx-intl.git repository root as::
$ pip install -U pip setuptools wheel setuptools_scm
$ pip install -r requirements-dev.txt
* Install Transifex CLI tool (refer to `Installation instructions <https://github.com/transifex/cli>`_)::
$ curl -o- https://raw.githubusercontent.com/transifex/cli/master/install.sh | bash
Testing
=======
Tests with supported python version that are in:
* ``tox.ini``
* ``.github/workflow/test.yml``
Run test
--------
Just run tox::
$ tox
tox have several sections for testing.
CI (Continuous Integration)
----------------------------
All tests will be run on GitHub Actions.
* https://github.com/sphinx-doc/sphinx-intl/tree/master/.github/workflows/
Releasing
=========
New package version
-------------------
The sphinx-intl package will be uploaded to PyPI: https://pypi.org/project/sphinx-intl/.
Here is a release procedure:
.. include:: ../checklist.rst
Updated documentation
---------------------
Sphinx documentation under ``doc/`` directory on the master branch will be automatically uploaded into ReadTheDocs: http://sphinx-intl.rtfd.io/.
|
