Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit b2311cc

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

34 files changed

+139
-2
lines changed

‎changelog.d/pr435.doc.rst

Copy file name to clipboard
+7Lines 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

Copy file name to clipboardExpand all lines: docs/advanced/combine-pydantic-and-semver.rst
+4Lines 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

Copy file name to clipboardExpand all lines: docs/advanced/convert-pypi-to-semver.rst
+5-1Lines 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

Copy file name to clipboardExpand all lines: docs/advanced/create-subclasses-from-version.rst
+4Lines 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

Copy file name to clipboardExpand all lines: docs/advanced/deal-with-invalid-versions.rst
+4Lines 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

Copy file name to clipboardExpand all lines: docs/advanced/display-deprecation-warnings.rst
+4Lines 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

Copy file name to clipboardExpand all lines: docs/advanced/index.rst
+3Lines 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

Copy file name to clipboardExpand all lines: docs/advanced/version-from-file.rst
+5-1Lines 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

Copy file name to clipboardExpand all lines: docs/api.rst
+4Lines 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

Copy file name to clipboardExpand all lines: docs/build-semver.rst
+3Lines 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/

‎docs/contribute/add-changelog-entry.rst

Copy file name to clipboardExpand all lines: docs/contribute/add-changelog-entry.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,9 @@
33
Adding a Changelog Entry
44
========================
55

6+
.. meta::
7+
:description lang=en:
8+
Adding a changelog entry with Towncrier
9+
610
.. include:: ../../changelog.d/README.rst
711
:start-after: -text-begin-

‎docs/contribute/doc-semver.rst

Copy file name to clipboardExpand all lines: docs/contribute/doc-semver.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Documenting semver
44
==================
55

6+
.. meta::
7+
:description lang=en:
8+
Documenting semver with type annotations, docstrings, Sphinx directives
9+
610
Documenting the features of semver is very important. It gives our developers
711
an overview what is possible with semver, how it "feels", and how it is
812
used efficiently.

‎docs/contribute/finish-release.rst

Copy file name to clipboardExpand all lines: docs/contribute/finish-release.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Finish the Release
44
==================
55

6+
.. meta::
7+
:description lang=en:
8+
Finish the semver release by creating tags
9+
610
1. Create a tag:
711

812
$ git tag -a x.x.x

‎docs/contribute/index.rst

Copy file name to clipboardExpand all lines: docs/contribute/index.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Contributing to semver
44
======================
55

6+
.. meta::
7+
:description lang=en:
8+
Contributing to Python semver
9+
610
The semver source code is managed using Git and is hosted on GitHub::
711

812
git clone git://github.com/python-semver/python-semver

‎docs/contribute/prerequisites.rst

Copy file name to clipboardExpand all lines: docs/contribute/prerequisites.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
Prerequisites
22
-------------
33

4+
.. meta::
5+
:description lang=en:
6+
Overview of prerequisites for contributing
7+
48
.. -text-begin-
59
610
Before you make changes to the code, we would highly appreciate if you

‎docs/contribute/release-procedure.rst

Copy file name to clipboardExpand all lines: docs/contribute/release-procedure.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
Release Procedure
22
=================
33

4+
.. meta::
5+
:description lang=en:
6+
Release procedure: prepare and create the release
7+
48
The following procedures gives a short overview of what steps are needed
59
to create a new release.
610

‎docs/contribute/report-bugs.rst

Copy file name to clipboardExpand all lines: docs/contribute/report-bugs.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Reporting Bugs and Asking Questions
44
-----------------------------------
55

6+
.. meta::
7+
:description lang=en:
8+
Reporting bugs and asking questions about semver
9+
610
If you think you have encountered a bug in semver or have an idea for a new
711
feature? Great! We like to hear from you!
812

‎docs/contribute/run-test-suite.rst

Copy file name to clipboardExpand all lines: docs/contribute/run-test-suite.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Running the Test Suite
44
======================
55

6+
.. meta::
7+
:description lang=en:
8+
Running the test suite through tox
9+
610
We use `pytest`_ and `tox`_ to run tests against all supported Python
711
versions. All test dependencies are resolved automatically.
812

‎docs/index.rst

Copy file name to clipboardExpand all lines: docs/index.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
Semver |version| -- Semantic Versioning
22
=======================================
33

4+
.. meta::
5+
:description lang=en:
6+
Semantic versioning for Python
7+
48
.. include:: readme.rst
59

610

‎docs/install.rst

Copy file name to clipboardExpand all lines: docs/install.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
Installing semver
22
=================
33

4+
.. meta::
5+
:description lang=en:
6+
Installing semver on the system
7+
48
Release Policy
59
--------------
610

‎docs/migration/index.rst

Copy file name to clipboardExpand all lines: docs/migration/index.rst
+3Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
Migrating to semver3
22
====================
33

4+
.. meta::
5+
:description lang=en:
6+
Migrating from semver version 2 to version 3
47

58
.. toctree::
69
:maxdepth: 1

‎docs/migration/migratetosemver3.rst

Copy file name to clipboardExpand all lines: docs/migration/migratetosemver3.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Migrating from semver2 to semver3
44
=================================
55

6+
.. meta::
7+
:description lang=en:
8+
Migrating from semver2 to semver3
9+
610
This section describes the visible differences for
711
users and how your code stays compatible for semver3.
812
Some changes are backward incompatible.

‎docs/migration/replace-deprecated-functions.rst

Copy file name to clipboardExpand all lines: docs/migration/replace-deprecated-functions.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Replacing Deprecated Functions
44
==============================
55

6+
.. meta::
7+
:description lang=en:
8+
Replacing deprecated functions
9+
610
.. versionchanged:: 2.10.0
711
The development team of semver has decided to deprecate certain functions on
812
the module level. The preferred way of using semver is through the

‎docs/pysemver.rst

Copy file name to clipboardExpand all lines: docs/pysemver.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
pysemver |version|
44
==================
55

6+
.. meta::
7+
:description lang=en:
8+
Commandline tool pysemver describing all commands and options
9+
610
Synopsis
711
--------
812

‎docs/usage/access-parts-of-a-version.rst

Copy file name to clipboardExpand all lines: docs/usage/access-parts-of-a-version.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Accessing Parts of a Version Through Names
44
==========================================
55

6+
.. meta::
7+
:description lang=en:
8+
Accessing parts of a version through names
9+
610
The :class:`~semver.version.Version` class contains attributes to access the different
711
parts of a version:
812

‎docs/usage/access-parts-through-index.rst

Copy file name to clipboardExpand all lines: docs/usage/access-parts-through-index.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Accessing Parts Through Index Numbers
44
=====================================
55

6+
.. meta::
7+
:description lang=en:
8+
Accessing parts through index numbers
9+
610
.. versionadded:: 2.10.0
711

812
Another way to access parts of a version is to use an index notation. The underlying

‎docs/usage/check-compatible-semver-version.rst

Copy file name to clipboardExpand all lines: docs/usage/check-compatible-semver-version.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
Checking for a Compatible Semver Version
22
========================================
33

4+
.. meta::
5+
:description lang=en:
6+
Check for a compatible semver version
7+
48
To check if a *change* from a semver version ``a`` to a semver
59
version ``b`` is *compatible* according to semver rule, use the method
610
:meth:`~semver.version.Version.is_compatible`.

‎docs/usage/check-valid-semver-version.rst

Copy file name to clipboardExpand all lines: docs/usage/check-valid-semver-version.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
Checking for a Valid Semver Version
22
===================================
33

4+
.. meta::
5+
:description lang=en:
6+
Checking for a valid semver version
7+
48
If you need to check a string if it is a valid semver version, use the
59
classmethod :meth:`~semver.version.Version.is_valid`:
610

‎docs/usage/compare-versions-through-expression.rst

Copy file name to clipboardExpand all lines: docs/usage/compare-versions-through-expression.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
Comparing Versions through an Expression
22
========================================
33

4+
.. meta::
5+
:description lang=en:
6+
Comparing versions through an expression
7+
48
If you need a more fine-grained approach of comparing two versions,
59
use the :meth:`~semver.version.Version.match` function. It expects two arguments:
610

‎docs/usage/compare-versions.rst

Copy file name to clipboardExpand all lines: docs/usage/compare-versions.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
Comparing Versions
22
==================
33

4+
.. meta::
5+
:description lang=en:
6+
Comparing versions with semver.compare and the Version class
7+
48
To compare two versions depends on your type:
59

610
* **Two strings**

‎docs/usage/convert-version-into-different-types.rst

Copy file name to clipboardExpand all lines: docs/usage/convert-version-into-different-types.rst
+5Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
Converting a Version instance into Different Types
44
==================================================
55

6+
.. meta::
7+
:description lang=en:
8+
Converting a version instance into different types
9+
10+
611
Sometimes it is needed to convert a :class:`~semver.version.Version` instance into
712
a different type. For example, for displaying or to access all parts.
813

‎docs/usage/create-a-version.rst

Copy file name to clipboardExpand all lines: docs/usage/create-a-version.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
Creating a Version
22
==================
33

4+
.. meta::
5+
:description lang=en:
6+
Creating a version using different methods
7+
48
.. versionchanged:: 3.0.0
59

610
The former :class:`~semver.version.VersionInfo` class

‎docs/usage/determine-version-equality.rst

Copy file name to clipboardExpand all lines: docs/usage/determine-version-equality.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
Determining Version Equality
22
============================
33

4+
.. meta::
5+
:description lang=en:
6+
Determining verison equality
7+
48
Version equality means for semver, that major, minor, patch, and prerelease
59
parts are equal in both versions you compare. The build part is ignored.
610
For example::

‎docs/usage/get-min-and-max-of-multiple-versions.rst

Copy file name to clipboardExpand all lines: docs/usage/get-min-and-max-of-multiple-versions.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Getting Minimum and Maximum of Multiple Versions
44
================================================
55

6+
.. meta::
7+
:description lang=en:
8+
Getting minimum and maximum of multiple versions
9+
610
.. versionchanged:: 2.10.2
711
The functions :func:`semver.max_ver` and :func:`semver.min_ver` are deprecated in
812
favor of their builtin counterparts :func:`max` and :func:`min`.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.