diff options
| author | Ryan Nelson <rnelsonchem@gmail.com> | 2014-11-30 17:09:50 -0500 |
|---|---|---|
| committer | Ryan Nelson <rnelsonchem@gmail.com> | 2015-01-10 07:45:52 -0500 |
| commit | 557108cd2406a7c98e2aa88d2f5a04bbf3bbf4a0 (patch) | |
| tree | 8af92ff1d35beaf57e9c8226eed3bb21d5efc381 /doc/HOWTO_BUILD_DOCS.rst.txt | |
| parent | 31b94e85a99db998bd6156d2b800386973fef3e1 (diff) | |
| download | numpy-557108cd2406a7c98e2aa88d2f5a04bbf3bbf4a0.tar.gz | |
DOC: Update Development Workflow Page
The "Basic Workflow" section of the Development Workflow page was reorganized
to make it clearer to new users and remove/update old material.
Major changes:
- Moved the core developer notes. Core dev notes are confusing in basic usage
information. Updated a couple of the commands
- Added more commands and reorgaized the "New Feature Branch" section. Took
some text from "Rebasing" and moved it here, because it was redundant.
- Made many changes to the "Editing Workflow" to clarify commands. Moved some
git push stuff into this section as well.
- Moved pull request section to just after editing workflow. Removed outdated
images and simplified the text. Make code review requirements explicit.
- Moved rebasing and troubleshooting sections to the end. Could add more here
later.
- Links renamed and broken link removed.
Diffstat (limited to 'doc/HOWTO_BUILD_DOCS.rst.txt')
| -rw-r--r-- | doc/HOWTO_BUILD_DOCS.rst.txt | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/HOWTO_BUILD_DOCS.rst.txt b/doc/HOWTO_BUILD_DOCS.rst.txt index b43996899..79d76fb7d 100644 --- a/doc/HOWTO_BUILD_DOCS.rst.txt +++ b/doc/HOWTO_BUILD_DOCS.rst.txt @@ -24,6 +24,11 @@ additional parts required for building the documentation:: git submodule init git submodule update +In addition, building the documentation requires the Sphinx extension +`plot_directive`, which is shipped with Matplotlib_. This Sphinx extension can +be installed with or without completely installing Matplotlib: see the +Matplotlib documentation for more information. + Since large parts of the main documentation are stored in docstrings, you will need to first build Numpy, and install it so that the correct version is imported by @@ -39,7 +44,7 @@ After Numpy is installed, write:: make html -in this ``doc/`` directory. If all goes well, this will generate a +in the ``doc/`` directory. If all goes well, this will generate a ``build/html`` subdirectory containing the built documentation. Note that building the documentation on Windows is currently not actively supported, though it should be possible. (See Sphinx_ documentation @@ -60,6 +65,7 @@ which will rebuild Numpy, install it to a temporary location, and build the documentation in all formats. This will most likely again only work on Unix platforms. +.. _Matplotlib: http://matplotlib.org/ Sphinx extensions ----------------- |