FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Merge pull request #435 from tomschr/doc-improvements · python-semver/python-semver@b2311cc · GitHub

/ python-semver Public

Commit b2311cc

Browse files
tomschr
authored
Merge pull request #435 from tomschr/doc-improvements
Use meta directive for SEO
2 parents 87f639f + ca41533 commit b2311cc

34 files changed

Lines changed: 139 additions & 2 deletions

‎changelog.d/pr435.doc.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Several small improvements for documentation:
2+
3+
* Add meta description to improve SEO
4+
* Use canonicals on ReadTheDocs (commit 87f639f)
5+
* Pin versions for reproducable doc builds (commit 03fb990)
6+
* Add missing :file:`.readthedocs.yaml` file (commit ec9348a)
7+
* Correct some smaller issues when building (commit f65feab)

‎docs/advanced/combine-pydantic-and-semver.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
Combining Pydantic and semver
22
=============================
33

4+
.. meta::
5+
:description lang=en:
6+
Combining Pydantic and semver
7+
48
According to its homepage, `Pydantic <https://pydantic-docs.helpmanual.io>`_
59
"enforces type hints at runtime, and provides user friendly errors when data
610
is invalid."

‎docs/advanced/convert-pypi-to-semver.rst‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
Converting versions between PyPI and semver
1+
Converting Versions between PyPI and semver
22
===========================================
33

4+
.. meta::
5+
:description lang=en:
6+
Converting versions between PyPI and semver
7+
48
.. Link
59
https://packaging.pypa.io/en/latest/_modules/packaging/version.html#InvalidVersion
610

‎docs/advanced/create-subclasses-from-version.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Creating Subclasses from Version
44
================================
55

6+
.. meta::
7+
:description lang=en:
8+
Creating subclasses from Version class
9+
610
If you do not like creating functions to modify the behavior of semver
711
(as shown in section :ref:`sec_dealing_with_invalid_versions`), you can
812
also create a subclass of the :class:`Version <semver.version.Version>` class.

‎docs/advanced/deal-with-invalid-versions.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Dealing with Invalid Versions
44
=============================
55

6+
.. meta::
7+
:description lang=en:
8+
Dealing with invalid versions
9+
610
As semver follows the semver specification, it cannot parse version
711
strings which are considered "invalid" by that specification. The semver
812
library cannot know all the possible variations so you need to help the

‎docs/advanced/display-deprecation-warnings.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Displaying Deprecation Warnings
44
===============================
55

6+
.. meta::
7+
:description lang=en:
8+
Displaying and filtering deprecation warnings
9+
610
By default, deprecation warnings are `ignored in Python <https://docs.python.org/3/library/warnings.html#warning-categories>`_.
711
This also affects semver's own warnings.
812

‎docs/advanced/index.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
Advanced topics
22
===============
33

4+
.. meta::
5+
:description lang=en:
6+
Advanced topics for Python semver
47

58
.. toctree::
69
:maxdepth: 1

‎docs/advanced/version-from-file.rst‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
.. _sec_reading_versions_from_file:
22

3-
Reading versions from file
3+
Reading Versions from File
44
==========================
55

6+
.. meta::
7+
:description lang=en:
8+
Reading versions from file
9+
610
In cases where a version is stored inside a file, one possible solution
711
is to use the following function:
812

‎docs/api.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
API Reference
44
=============
55

6+
.. meta::
7+
:description lang=en:
8+
API reference about Python semver
9+
610
.. currentmodule:: semver
711

812

‎docs/build-semver.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
Building semver
44
===============
55

6+
.. meta::
7+
:description lang=en:
8+
Building semver
69

710
.. _PEP 517: https://www.python.org/dev/peps/pep-0517/
811
.. _PEP 621: https://www.python.org/dev/peps/pep-0621/

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL