Skip to content

Commit ab30c9f

Browse files
committed
- Documentation improvements.
1 parent d964760 commit ab30c9f

File tree

3 files changed

+23
-18
lines changed

3 files changed

+23
-18
lines changed

SECURITY.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
| Version | Supported |
66
| ------- | ------------------ |
7-
| 1.0.x | :white_check_mark: |
8-
| < 1.0.x | :x: |
7+
| 1.2.x | :white_check_mark: |
8+
| < 1.2.x | :x: |
99

1010
## Reporting a Vulnerability
1111

docs/_templates/sidebartoc.html

+15-10
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
11
<h3>Getting Around</h3>
22
<ul>
3-
<li><a class="reference internal" href="index.html">Basic Usage</a>
3+
<li><a class="reference internal" href="{{ pathto(master_doc) }}">Basic Usage</a>
44
<ul>
5-
<li><a class="reference internal" href="index.html#installation">Installation</a></li>
6-
<li><a class="reference internal" href="index.html#configuration">Configuration</a></li>
7-
<li><a class="reference internal" href="index.html#customizing-the-response">Customizing the Response</a>
5+
<li><a class="reference internal" href="{{ pathto(master_doc) | trim("#") }}#installation">Installation</a>
86
</li>
9-
<li><a class="reference internal" href="index.html#plugins">Plugins</a></li>
10-
<li><a class="reference internal" href="index.html#integrating-with-hookee">Integrating with <span
11-
class="pre">hookee</span></a></li>
7+
<li><a class="reference internal"
8+
href="{{ pathto(master_doc) | trim("#") }}#configuration">Configuration</a></li>
9+
<li><a class="reference internal" href="{{ pathto(master_doc) | trim("#") }}#customizing-the-response">Customizing
10+
the Response</a>
11+
</li>
12+
<li><a class="reference internal" href="{{ pathto(master_doc) | trim("#") }}#plugins">Plugins</a></li>
13+
<li><a class="reference internal" href="{{ pathto(master_doc) | trim("#") }}#integrating-with-hookee">Integrating
14+
with <span
15+
class="pre">hookee</span></a></li>
1216
</ul>
1317
</li>
14-
<li><a class="reference internal" href="index.html#dive-deeper">Dive Deeper</a>
18+
<li><a class="reference internal" href="{{ pathto(master_doc) | trim("#") }}#dive-deeper">Dive Deeper</a>
1519
<ul>
16-
<li><a class="reference internal" href="api.html">API Documentation</a></li>
20+
<li><a class="reference internal" href="{{ pathto("api") }}">API Documentation</a></li>
1721
<li><a href="https://github.com/alexdlaird/hookee/blob/master/CHANGELOG.md">Changelog</a></li>
1822
<li><a href="https://github.com/alexdlaird/hookee/issues">Issues</a></li>
19-
<li><a class="reference internal" href="index.html#contributing">Contributing</a></li>
23+
<li><a class="reference internal" href="{{ pathto(master_doc) | trim("#") }}#contributing">Contributing</a>
24+
</li>
2025
</ul>
2126
</li>
2227
</ul>

docs/api.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,24 @@ Plugin Manager
2020
:private-members:
2121
:show-inheritance:
2222

23-
Config
24-
------
23+
Configuration
24+
-------------
2525

2626
.. automodule:: hookee.conf
2727
:members:
2828
:private-members:
2929
:show-inheritance:
3030

31-
Server
32-
------
31+
Server Manager
32+
--------------
3333

3434
.. automodule:: hookee.server
3535
:members:
3636
:private-members:
3737
:show-inheritance:
3838

39-
Tunnel
40-
------
39+
Tunnel Manager
40+
--------------
4141

4242
.. automodule:: hookee.tunnel
4343
:members:

0 commit comments

Comments
 (0)