https://github.com/sphinx-contrib/mscgen

https://github.com/sphinx-contrib/mscgen

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/sphinx-contrib/mscgen
• Owner: sphinx-contrib
• License: other
• Created: 2017-09-28T14:54:11.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2025-03-08T13:34:42.000Z (4 months ago)
• Last Synced: 2025-04-07T15:01:32.034Z (3 months ago)
• Language: Python
• Size: 35.2 KB
• Stars: 2
• Watchers: 4
• Forks: 13
• Open Issues: 1
• Metadata Files:
  • Readme: README.MAINTAINER
  • Changelog: CHANGES
  • License: LICENSE

Awesome Lists containing this project

README

        

========================

Maintainer documentation

========================

This document contains notes for developers and packagers. End users probably

want to read ``README`` and the files in the ``doc`` directory instead.

PyPi Release

============

1. Make sure the repository is up-to date.

2. Ensure the version is incremented:

   - ``setup.py``  must be updated

   - ``doc/config.py``  must be updated

   - ``CHANGES.txt``  must contain a summary of the changes

3. Make sure all changes are committed, including the version number changes.

4. Tag the sources with ``git tag X.Y``.

5. Don't forget to ``git push upstream X.Y``.

6. Temporarily modify the ``setup.cfg`` file to comment out the variables

   ``tag_build = dev`` and ``tag_date = true`` (do **not** commit this

   changes).

7. Register and package the new release ``python setup.py register sdist``.

8. Upload the new release: ``twine upload dist/*``

9. Generate the documentation with ``make -C doc zip``.

10. Upload the new documentation (``doc/_build/sphinxcontrib-mscgen-doc.zip``)

    to PyPi:

    http://pypi.python.org/pypi?%3Aaction=pkg_edit&name=sphinxcontrib-mscgen

.. vim: set filetype=rst :