update docs to reflect move away from setup.py

apdavison · apdavison · commit 5927a652ed84 · 2023-01-12T14:27:19.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,5 @@ dist
 .settings
 .idea
 .*cache/
+_version.py
+MANIFEST
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,2 +1,3 @@
 include CHANGES.txt
 include quantities/constants/NIST_codata.txt
+exclude conda.recipe
diff --git a/README.rst b/README.rst
@@ -65,11 +65,8 @@ http://docs.scipy.org/doc/numpy/user/install.html
 
 To install quantities itself, then simply run::
 
-    $ python setup.py install --user
+    $ pip install quantities
 
-If you install it system-wide, you may need to prefix the previous command with ``sudo``::
-
-    $ sudo python setup.py install
 
 Tests
 -----
diff --git a/conda.recipe/meta.yaml b/conda.recipe/meta.yaml
@@ -22,5 +22,5 @@ test:
 
 about:
   license: BSD
-  home: http://pythonhosted.org//quantities/
+  home: https://github.com/python-quantities/python-quantities/
   summary: Physical quantities with units, based upon Numpy
diff --git a/doc/devel/devnotes.rst b/doc/devel/devnotes.rst
@@ -5,7 +5,4 @@ Quantities development uses the principles of test-driven development. New
 features or bug fixes need to be accompanied by unit tests based on Python's
 unittest package. Unit tests can be run with the following::
 
-  python setup.py test
-
-This works with the version of unittest provided by the python-2.7 and
-python-3.2+ standard library.
+  pytest
diff --git a/doc/devel/documenting.rst b/doc/devel/documenting.rst
@@ -13,7 +13,7 @@ Sphinx extension. Sphinx-0.6.3 or later is required. You can obtain
 Sphinx and numpydoc from the `Python Package Index`_ or
 by doing::
 
-  easy_install sphinx
+  pip install sphinx
 
 .. _Sphinx: http://sphinx.pocoo.org/
 .. _numpydoc: http://pypi.python.org/pypi/numpydoc
@@ -37,7 +37,7 @@ Organization of Quantities' documentation
 ==========================================
 
 The actual ReStructured Text files are kept in :file:`doc`. The main
-entry point is :file:`doc/index.rst`, which pulls in the 
+entry point is :file:`doc/index.rst`, which pulls in the
 :file:`index.rst` file for the user guide and the developers guide.
 The documentation suite is built as a single document in order to
 make the most effective use of cross referencing, we want to make
@@ -314,4 +314,3 @@ Some helpful functions::
     C-c C-r rst-shift-region-right
 
         Shift region to the right
-
diff --git a/doc/devel/release.rst b/doc/devel/release.rst
@@ -8,8 +8,8 @@ Creating Source Releases
 Quantities is distributed as a source release for Linux and Mac OS. To create a
 source release, just do::
 
-  python setup.py register
-  python setup.py sdist --formats=zip,gztar
+  pip install build
+  python -m build
   twine upload dist/quantities-<x.y.z>.*
 
 (replacing `x`, `y` and `z` appropriately).
@@ -23,24 +23,11 @@ like::
 
 You can create a source distribution without uploading by doing::
 
-  python setup.py sdist
+  python -m build --sdist
 
 This creates a source distribution in the `dist/` directory.
 
 
-Creating Windows Installers
-===========================
-
-We distribute binary installers for the windows platform. In order to build the
-windows installer, open a DOS window, cd into the quantities source directory
-and run::
-
-  python setup.py build
-  python setup.py bdist_msi
-
-This creates the executable windows installer in the `dist/` directory.
-
-
 Building Quantities documentation
 =================================
 
diff --git a/doc/user/installation.rst b/doc/user/installation.rst
@@ -17,9 +17,8 @@ Quantities has a few dependencies:
 Source Code Installation
 ========================
 
-To install Quantities, download the Quantites sourcecode from PyPI_
-and run "python setup.py install" in the quantities source directory,
-or run "pip install quantities".
+To install Quantities, run "pip install quantities".
+
 
 Development
 ===========

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`include CHANGES.txt`
`2`	`2`	`include quantities/constants/NIST_codata.txt`
	`3`	`+exclude conda.recipe`