Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure usage section #350

Merged
merged 2 commits into from
Jan 23, 2022

Conversation

tomschr
Copy link
Member

@tomschr tomschr commented Jan 22, 2022

This PR restructures docs/usage.rst into different files under the docs/usage/ directory.

Reason: The file docs/usage.rst becomes too big to maintain. It's easier to have shorter files. Additonally, failed doctests are easier to locate.

* Missing merge step
* Introduce the subsection "Finish the release"
The usage.rst file become quite big and it is hard
to maintain.
It's now splitted up into different files in the
subfolder "usage/". The index.rst collects all these
files.
@tomschr tomschr added the Doc Documentation related issue label Jan 22, 2022
@tomschr tomschr self-assigned this Jan 22, 2022
@tomschr tomschr merged commit 6b6cba8 into python-semver:master Jan 23, 2022
tomschr added a commit to tomschr/python-semver that referenced this pull request Jan 23, 2022
@tomschr tomschr deleted the feature/docs-put-usage-in-dir branch January 23, 2022 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Doc Documentation related issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant