Stuck on an issue?
Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.
And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.
[docs] use `versionadded`, `versionchanged` and `deprecated` directive
See original GitHub issue🚀 Feature
Use .. versionadded::, .. versionchanged:: and .. deprecated:: directive, so that user knows which features are added / changed / deprecated in which version and they can navigate the docs easily without changing the docs from version to version.
Ref: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionadded
Issue Analytics
- State:
- Created 3 years ago
- Reactions:1
- Comments:5 (2 by maintainers)
Top Results From Across the Web
[docs] use `versionadded`, `versionchanged` and `deprecated ...
deprecated :: directive, so that user knows which features are added / changed / deprecated in which version and they can navigate the...
Read more >Directives - Sphinx documentation
This directive inserts a “TOC tree” at the current location, using the ... Similar to versionchanged , but describes when the feature was...
Read more >changeset — sphinx-toolbox 3.2.0 documentation
Customised versions of Sphinx's versionadded , versionchanged and deprecated directives to correctly handle bullet lists. New in version 2.11.0.
Read more >[docs] use `versionadded`, `versionchanged` and `deprecated ...
[docs] use `versionadded`, `versionchanged` and `deprecated` directive.
Read more >Help: Add ".. versionadded" directive to every top level .rst document ...
... directives: .. versionadded , .. versionchanged and .. deprecated . Its easy to automate version tagging ( .. versionadded ) for top...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
@ydcjeff could you please mention those
versionadded,versionchangedin the CONTRIBUTING in the docs section. Thanks !Yes, starting from v0.5.0 sounds good. Maybe later we can add other marks for v0.4.0 as well.