Skip to content

Commit aa6dd2c

Browse files
committed
Improve doc navigation
- move project links to sidebar - include table of contents on page
1 parent afb99ab commit aa6dd2c

File tree

3 files changed

+5
-8
lines changed

3 files changed

+5
-8
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1414
### Changed
1515

1616
- Added some additional metadata to PyPI distribution
17+
- Minor improvements to structure of docs
1718

1819
## 1.0.1 - 2019-02-20
1920

docs/conf.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,8 @@
9191
'github_banner': True,
9292
'description': 'A client for Akamai Fast Purge',
9393
'extra_nav_links': {
94-
'API Reference': 'index.html',
94+
'Source': 'https://github.com/release-engineering/python-fastpurge',
95+
'PyPI': 'https://pypi.org/project/fastpurge',
9596
'Index': 'genindex.html',
9697
}
9798
}

docs/index.rst

+2-7
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,8 @@ fastpurge
33

44
A client for the `Akamai Fast Purge API`_.
55

6-
.. toctree::
7-
:maxdepth: 2
8-
:caption: Contents:
9-
10-
- `Source <https://github.com/release-engineering/python-fastpurge>`_
11-
- `Documentation <https://release-engineering.github.io/python-fastpurge/>`_
12-
- `PyPI <https://pypi.org/project/fastpurge>`_
6+
.. contents::
7+
:local:
138

149
Quick Start
1510
-----------

0 commit comments

Comments
 (0)