Skip to content

Commit 90da8ba

Browse files
nejchJohnVillalovos
nejch
authored and
JohnVillalovos
committed
docs: consolidate changelogs and remove v3 API docs
1 parent ce4bc0d commit 90da8ba

11 files changed

+998
-894
lines changed

‎CHANGELOG.md

Lines changed: 988 additions & 0 deletions
Large diffs are not rendered by default.

‎ChangeLog.rst

Lines changed: 0 additions & 772 deletions
This file was deleted.

‎MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
include COPYING AUTHORS ChangeLog.rst RELEASE_NOTES.rst requirements*.txt
1+
include COPYING AUTHORS CHANGELOG.md requirements*.txt
22
include tox.ini
33
recursive-include tests *
44
recursive-include docs *j2 *.py *.rst api/*.rst Makefile make.bat

‎docs/changelog.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```{include} ../CHANGELOG.md
2+
```

‎docs/changelog.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3939
# ones.
4040
extensions = [
41+
"myst_parser",
4142
"sphinx.ext.autodoc",
4243
"sphinx.ext.autosummary",
4344
"ext.docstrings",
@@ -48,7 +49,7 @@
4849
templates_path = ["_templates"]
4950

5051
# The suffix of source filenames.
51-
source_suffix = ".rst"
52+
source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
5253

5354
# The encoding of source files.
5455
# source_encoding = 'utf-8-sig'

‎docs/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,8 @@ Contents:
1818
api-objects
1919
api/gitlab
2020
cli-objects
21-
release_notes
2221
changelog
23-
switching-to-v4
22+
release-notes
2423

2524

2625
Indices and tables

‎RELEASE_NOTES.rst renamed to ‎docs/release-notes.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
Release notes
33
#############
44

5-
This page describes important changes between python-gitlab releases.
5+
Prior to version 2.0.0 and GitHub Releases, a summary of changes was maintained
6+
in release notes. They are available below for historical purposes.
7+
For the list of current releases, including breaking changes, please see the changelog.
68

79
Changes from 1.8 to 1.9
810
=======================

‎docs/release_notes.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/switching-to-v4.rst

Lines changed: 0 additions & 115 deletions
This file was deleted.

‎requirements-docs.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
-r requirements.txt
22
jinja2
3+
myst-parser
34
sphinx==3.5.4
45
sphinx_rtd_theme
56
sphinxcontrib-autoprogram

0 commit comments

Comments
 (0)