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
|
********
Releases
********
Creating Source Releases
========================
Quantities is distributed as a source release for Linux and Mac OS. To create a
source release, just do::
pip install build
python -m build
twine upload dist/quantities-<x.y.z>.*
(replacing `x`, `y` and `z` appropriately).
This will create the tgz source file and upload it to the Python Package Index.
Uploading to PyPi requires a .pypirc file in your home directory, something
like::
[server-login]
username: <username>
password: <password>
You can create a source distribution without uploading by doing::
python -m build --sdist
This creates a source distribution in the `dist/` directory.
Building Quantities documentation
=================================
The Quantities documentation is automatically built on readthedocs.io.
Should you need to build the documentation locally,
Sphinx_, LaTeX_ (preferably `TeX-Live`_), and dvipng_ are
required. Once these are installed, do::
cd doc
make html
which will produce the html output and save it in build/sphinx/html. Then run::
make latex
cd build/latex
make all-pdf
cp Quantities.pdf ../html
which will generate a pdf file in the latex directory.
.. _Sphinx: http://sphinx.pocoo.org/
.. _LaTeX: http://www.latex-project.org/
.. _`TeX-Live`: http://www.tug.org/texlive/
.. _dvipng: http://savannah.nongnu.org/projects/dvipng/
|
