Skip to content

Commit

Permalink
Update developers_guide.rst (#185)
Browse files Browse the repository at this point in the history
Added an important line reminding to update the `modules.rst` file and references.
  • Loading branch information
alperyeg authored and mdenker committed Oct 24, 2018
1 parent 0389151 commit d203397
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/developers_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,8 @@ First, check that the version string (in :file:`elephant/__init__.py`, :file:`se

Second, check that the copyright statement (in :file:`LICENCE.txt`, :file:`README.md`, and :file:`doc/conf.py`) is correct.

Third, if there is a new module do not forget to add the modulename to the :file:`doc/module.rst` and make a file with a short description in :file:`doc/reference/<modulename>.rst`.

To build a source package::

$ python setup.py sdist
Expand Down

0 comments on commit d203397

Please sign in to comment.