Skip to content

Commit 55030fc

Browse files
committed
Update to reflect the new canonical location for the documentation, on readthedocs.io
[skip ci]
1 parent a21dc46 commit 55030fc

File tree

3 files changed

+9
-15
lines changed

3 files changed

+9
-15
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Documentation and usage
2828
-----------------------
2929
You can find the official documenation at:
3030

31-
http://packages.python.org/quantities
31+
http://python-quantities.readthedocs.io/
3232

3333
Here is a simple example:
3434

doc/devel/release.rst

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,11 @@ This creates the executable windows installer in the `dist/` directory.
4242
Building Quantities documentation
4343
=================================
4444

45-
When publishing a new release, the Quantities doumentation needs to be generated
46-
and published as well. Sphinx_, LaTeX_ (preferably `TeX-Live`_), and dvipng_ are
47-
required to build the documentation. Once these are installed, do::
45+
The Quantities documentation is automatically built on readthedocs.io.
46+
47+
Should you need to build the documentation locally,
48+
Sphinx_, LaTeX_ (preferably `TeX-Live`_), and dvipng_ are
49+
required. Once these are installed, do::
4850

4951
cd doc
5052
make html
@@ -56,15 +58,7 @@ which will produce the html output and save it in build/sphinx/html. Then run::
5658
make all-pdf
5759
cp Quantities.pdf ../html
5860

59-
which will generate a pdf file in the latex directory. Finally, upload the html
60-
content to the http://packages.python.org/quantities/ webserver. To do so::
61-
62-
cd build/html
63-
zip -r quantities *
64-
65-
and then visit `the Quantities project page
66-
<http://pypi.python.org/pypi?%3Aaction=pkg_edit&name=quantities>`_ at the Python Package Index to
67-
upload the zip archive.
61+
which will generate a pdf file in the latex directory.
6862

6963
.. _Sphinx: http://sphinx.pocoo.org/
7064
.. _LaTeX: http://www.latex-project.org/

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ def run(self):
130130
and API are stable, test coverage is incomplete so the package is not
131131
suggested for mission-critical applications.
132132
133-
.. _tutorial: http://packages.python.org/quantities/user/tutorial.html
133+
.. _tutorial: http://python-quantities.readthedocs.io/en/latest/user/tutorial.html
134134
""",
135135
name = 'quantities',
136136
packages = packages,
@@ -139,7 +139,7 @@ def run(self):
139139
'python (>=2.7.0)',
140140
'numpy (>=1.8.2)',
141141
],
142-
url = 'http://packages.python.org/quantities',
142+
url = 'http://python-quantities.readthedocs.io/',
143143
version = versioneer.get_version(),
144144
)
145145

0 commit comments

Comments
 (0)