hiro/releases
1
0
Fork 0
mirror of https://github.com/vale981/releases synced 2025-03-04 17:21:43 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Overhaul new docs re #59 (plus some adjacent older stuff in same para)

Browse source
This commit is contained in:
Jeff Forcier 2018-05-01 13:36:26 -07:00
parent 3e9710e587
commit 73ee042925
1 changed files with 7 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/usage.rst
View file

@ -48,15 +48,13 @@ Specifically:
(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``.
* It is possible to have multiple changelogs (useful, for example, if you
are documenting multiple sub-projects). In this case set
``releases_docuement_name`` to a list containing all the changelogs you
want processed. Each changelog must be explicitly listed. E.g.
``releases_document_name = ['project_1/changelog', 'project_2/changes',
'changelog']``
* Elements before or after this bulleted list will be untouched by
Releases, allowing you to place e.g. paragraphs, comments etc at the top
(or bottom) of the document.
* It is possible to target multiple changelog files for mutation by setting
``releases_document_name`` to a list of strings instead of a single
string, e.g. ``releases_document_name = ['project_1/changelog',
'project_2/changes', 'changelog']``.
* Releases only modifies the bulleted list in these files and does not
touch other elements; this allows you to place paragraphs, comments etc
at the top (or bottom) of the document.
* List items are to be ordered chronologically with the newest ones on top.