diff --git a/docs/usage.rst b/docs/usage.rst index 2ee0b0b..4d61dea 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -34,6 +34,12 @@ Specifically: * Create a Sphinx document named ``changelog.rst`` with a top-level header followed by a bulleted list. + + * If you wish to use a different document name, use another config option + (as per previous bullet point), ``releases_document_name``. E.g. + ``releases_document_name = "CHANGES"`` would cause Releases to mutate a + file called ``CHANGES.rst`` instead of ``changelog.rst``. + * List items are to be ordered chronologically with the newest ones on top. * As you fix issues, put them on the top of the list. diff --git a/tests/changelog.py b/tests/changelog.py index 8528fe9..f2c9380 100644 --- a/tests/changelog.py +++ b/tests/changelog.py @@ -522,5 +522,5 @@ class integration(Spec): def configurable_document_name(self): doc = _doctree('notchangelog') - generate_changelog(_app(), doc) + generate_changelog(_app(document_name='notchangelog'), doc) _assert_changlogged(doc)