Skip to content

Commit bd15cfe

Browse files
committed
Add CHANGELOG to docs (READTHEDOCS)
1 parent 7beffb2 commit bd15cfe

File tree

4 files changed

+7
-1
lines changed

4 files changed

+7
-1
lines changed

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
# ones.
4343

4444
extensions = [
45+
'myst_parser',
4546
'sphinx.ext.autodoc',
4647
'sphinx.ext.coverage',
4748
'sphinx.ext.napoleon',

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ communication with the Audible API is supported.
6363
misc/logging
6464
misc/external_api
6565
misc/examples
66+
misc/changelog
6667
modules/audible
6768

6869

docs/source/misc/changelog.md

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

setup.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ def read_from_file(key):
5757
'sphinx',
5858
'sphinx_rtd_theme',
5959
'sphinxcontrib-httpdomain',
60-
'sphinx-autodoc-typehints'
60+
'sphinx-autodoc-typehints',
61+
'myst-parser'
6162
]
6263
},
6364
python_requires='>=3.6',

0 commit comments

Comments
 (0)