Skip to content

Commit 0ffb550

Browse files
committed
Introduce new topics for doc
* Move some files that better fit into an "Advanced topic" * Introduce "Migration to semver3" topic
1 parent 68553fe commit 0ffb550

16 files changed

+31
-10
lines changed

CONTRIBUTING.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ We recommend the following workflow:
6464
a. Write test cases and run the complete test suite, see :ref:`testsuite`
6565
for details.
6666

67-
b. Write a changelog entry, see section :ref:`changelog`.
67+
b. Write a changelog entry, see section :ref:`add-changelog`.
6868

6969
c. If you have implemented a new feature, document it into our
7070
documentation to help our reader. See section :ref:`doc` for
@@ -214,7 +214,7 @@ documentation includes:
214214
edge cases.
215215

216216

217-
.. _changelog:
217+
.. _add-changelog:
218218

219219
Adding a Changelog Entry
220220
------------------------
File renamed without changes.

docs/advanced/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Advanced topics
2+
===============
3+
4+
5+
6+
.. toctree::
7+
8+
deal-with-invalid-versions
9+
create-subclasses-from-version
10+
display-deprecation-warnings
File renamed without changes.

docs/changelog.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1+
.. _change-log:
2+
13
.. include:: ../CHANGELOG.rst

docs/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ Semver |version| -- Semantic Versioning
1111

1212
install
1313
usage/index
14-
migratetosemver3
14+
migration/index
15+
advanced/index
1516
development
1617
api
1718

@@ -31,6 +32,7 @@ Semver |version| -- Semantic Versioning
3132
changelog
3233
changelog-semver2
3334

35+
3436
Indices and Tables
3537
==================
3638

docs/migration/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Migrating to semver3
2+
====================
3+
4+
5+
.. toctree::
6+
:maxdepth: 1
7+
8+
migratetosemver3
9+
replace-deprecated-functions.rst

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy