Skip to content

Commit

Permalink
DOC, BLD: update doc build dependencies, remove as numpydoc submodule
Browse files Browse the repository at this point in the history
  • Loading branch information
mattip committed Sep 16, 2020
1 parent a182f32 commit 11d67d4
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 25 deletions.
26 changes: 2 additions & 24 deletions doc/source/docs/howto_document.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,29 +40,7 @@ after which you may use it::

np.fft.fft2(...)

.. rubric::
**For convenience the** `formatting standard`_ **is included below with an
example**

.. include:: ../../sphinxext/doc/format.rst

.. _example:

Example Source
==============

.. literalinclude:: ../../sphinxext/doc/example.py



Example Rendered
================

.. ifconfig:: python_version_major < '3'

The example is rendered only when sphinx is run with python3 and above

.. automodule:: doc.example
:members:
Please use the numpydoc `formatting standard`_ as shown in their example_

.. _`formatting standard`: https://numpydoc.readthedocs.io/en/latest/format.html
.. _example: https://numpydoc.readthedocs.io/en/latest/example.html
2 changes: 1 addition & 1 deletion doc_requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
pygments==2.6.1
sphinx>=2.2.0,<3.0
numpydoc==1.1.0
ipython
scipy
matplotlib
Expand Down

0 comments on commit 11d67d4

Please sign in to comment.