Repository navigation
Commit 90da8ba
docs: consolidate changelogs and remove v3 API docs
1 parent ce4bc0d commit 90da8ba
11 files changed
Lines changed: 998 additions & 894 deletions
Large diffs are not rendered by default.
This file was deleted.
| Original file line number | Diff line number | Diff 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 | ||
| 2 | 2 | include tox.ini | |
| 3 | 3 | recursive-include tests * | |
| 4 | 4 | recursive-include docs *j2 *.py *.rst api/*.rst Makefile make.bat | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,2 @@ | |||
| 1 | + ```{include} ../CHANGELOG.md | ||
| 2 | + ``` | ||
This file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -38,6 +38,7 @@ | |||
| 38 | 38 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | |
| 39 | 39 | # ones. | |
| 40 | 40 | extensions = [ | |
| 41 | + "myst_parser", | ||
| 41 | 42 | "sphinx.ext.autodoc", | |
| 42 | 43 | "sphinx.ext.autosummary", | |
| 43 | 44 | "ext.docstrings", | |
@@ -48,7 +49,7 @@ | |||
| 48 | 49 | templates_path = ["_templates"] | |
| 49 | 50 | ||
| 50 | 51 | # The suffix of source filenames. | |
| 51 | - source_suffix = ".rst" | ||
| 52 | + source_suffix = {".rst": "restructuredtext", ".md": "markdown"} | ||
| 52 | 53 | ||
| 53 | 54 | # The encoding of source files. | |
| 54 | 55 | # source_encoding = 'utf-8-sig' | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -18,9 +18,8 @@ Contents: | |||
| 18 | 18 | api-objects | |
| 19 | 19 | api/gitlab | |
| 20 | 20 | cli-objects | |
| 21 | - release_notes | ||
| 22 | 21 | changelog | |
| 23 | - switching-to-v4 | ||
| 22 | + release-notes | ||
| 24 | 23 | ||
| 25 | 24 | ||
| 26 | 25 | Indices and tables | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2,7 +2,9 @@ | |||
| 2 | 2 | Release notes | |
| 3 | 3 | ############# | |
| 4 | 4 | ||
| 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. | ||
| 6 | 8 | ||
| 7 | 9 | Changes from 1.8 to 1.9 | |
| 8 | 10 | ======================= | |
This file was deleted.
This file was deleted.
0 commit comments