Update documentation info (#2662)

4 files changed, 64 insertions, 12 deletions

diff --git a/RELEASE.rst b/RELEASE.rst
index 6ed871cf..84a9d247 100644
--- a/RELEASE.rst
+++ b/RELEASE.rst
@@ -51,13 +51,38 @@ How to make a new release of ``networkx``
   - Toggle ``dev = False`` to ``dev = True`` in ``networkx/release.py``.
   - Update ``major`` and ``minor`` in ``networkx/release.py``.
 
+- Build the documentation::
+
+    cd doc
+    make docs
+
+  The built documentation is in ``build/html``.
+
+- Push documentation to the web:
+  The documentation is kept in a separate repo: networkx/documentation
+
+  - Sync your branch with the remote repo: ``git pull``.
+  - Copy the documentation that you built in the previous step.
+    Assuming your ``networkx`` and your ``documentation`` repos are in the
+    same parent directory::
+
+      cp -a ../networkx/doc/build/html networkx-<major>.<minor> 
+      git add networkx-<major>.<minor>
+      git commit -m "Add <major>.<minor> docs"
+      git push
+
+  - Update the symlink to ``stable``.
+  - Push upstream
+
 - Update the web frontpage:
-  The webpage is kept in a separate repo: networkx-website
+  The webpage is kept in a separate repo: networkx/website
 
   - Sync your branch with the remote repo: ``git pull``.
     If you try to ``make github`` when your branch is out of sync, it
     creates headaches.
   - Update ``_templates/sidebar_versions.html``.
+  - Edit ``_static/docversions.js`` and commit
+  - Push your changes to the repo.
   - Deploy using ``make github``.
 
 - Update ``https://readthedocs.org/projects/networkx/versions/``
diff --git a/doc/Makefile b/doc/Makefile
index 802b77ed..833d1399 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -111,6 +111,9 @@ latexpdf: latex
 	$(MAKE) -C build/latex all-pdf
 	@echo "latexmk finished; the PDF files are in build/latex."
 
+docs: clean html latexpdf
+	cp build/latex/networkx_reference.pdf build/html/_downloads/.
+	
 gitwash-update:
 	python ../tools/gitwash_dumper.py developer networkx \
 	--project-url=http://networkx.github.io \
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 00000000..0205e03b
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,33 @@
+# Building docs
+
+We currently use Sphinx for generating the API and reference
+documentation for NetworkX.
+
+If you only want to get the documentation, note that pre-built
+versions can be found at
+
+    http://networkx.github.io/
+
+for both the stable and the latest (i.e., development) releases.
+
+## Instructions
+
+In addition to installing NetworkX and its dependencies, install the Python
+packages need to build the documentation by entering::
+
+   pip install -r requirements.txt
+
+in the ``doc/`` directory.
+
+To build the HTML documentation, enter::
+
+    make html
+
+in the ``doc/`` directory. If all goes well, this will generate a
+``build/html`` subdirectory containing the built documentation.
+
+To build the PDF documentation, enter::
+
+    make latexpdf
+
+You will need to have Latex installed for this.
diff --git a/doc/requirements.txt b/doc/requirements.txt
index fe015d05..d727adc2 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,11 +1,2 @@
-numpy >= 1.13.1
-matplotlib >= 2.0.2
-pandas >= 0.20.3
-pydot >= 1.2.3
-pygraphviz >= 1.3.1
-sphinx >= 1.6.3
-sphinx_rtd_theme >= 0.2.4
-sphinx-gallery >= 0.1.12
-pillow >= 4.2.1
-nb2plots >= 0.5.2
-texext >= 0.5
+-r ../requirements/doc.txt
+