Skip to content

Commit

Permalink
docs: Add changelog to documentation
Browse files Browse the repository at this point in the history
In order to allow Sphinx to process the changelog, change the underline
characters used by Towncrier to match the format used by the rest of our
documentation (otherwise, Sphinx tries to make one table of contents
entry for each version).  Add a symlink to `NEWS.rst` as
`docs/changelog.rst`, and indent the body of the ReST comment at the top
of the file.

Signed-off-by: Matt Wozniski <mwozniski@bloomberg.net>
  • Loading branch information
godlygeek authored and pablogsal committed May 16, 2022
1 parent f568eb9 commit 28f011a
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 10 deletions.
23 changes: 13 additions & 10 deletions NEWS.rst
Original file line number Diff line number Diff line change
@@ -1,33 +1,36 @@
.. note
You should *NOT* add new change log entries to this file, this
file is managed by towncrier. You *may* edit previous change logs to
fix problems like typo corrections or such.
You should *NOT* add new change log entries to this file, this
file is managed by towncrier. You *may* edit previous change logs to
fix problems like typo corrections or such.
Changelog
=========

.. towncrier release notes start
memray 1.0.3 (2022-04-21)
=========================
-------------------------

Features
--------
~~~~~~~~

- Add `memray` as a command line entry point. (#20)
- Add ``memray`` as a command line entry point. (#20)

memray 1.0.2 (2022-04-12)
=========================
-------------------------

Features
--------
~~~~~~~~

- Add publishing of ManyLinux2010 wheels for 64 and 32 bit systems. (#2)

Bug Fixes
---------
~~~~~~~~~

- Fix 32 bit builds. (#2)


memray 1.0.0 (2022-04-09)
=====================================
-------------------------

- Initial release.
1 change: 1 addition & 0 deletions docs/changelog.rst
6 changes: 6 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,9 @@ Memray can help with the following problems:
table
tree
stats

.. toctree::
:hidden:
:caption: Project Information

changelog
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ type = [
{ name = "Improved Documentation", directory = "doc", showcontent = true },
{ name = "Miscellaneous", directory = "misc", showcontent = true },
]
underlines = "-~"

[tool.pytest.ini_options]
markers = [
Expand Down

0 comments on commit 28f011a

Please sign in to comment.