Skip to content

Commit 623086b

Browse files
committed
Start re-organizing docs for rewrite
Let's group our documentation into functional areas: - api-reference for all auto-generated documentation of code in the library - contributing for all developers who contribute to the development of the library - narrative and examples for users of the library to understand how to use it Eventually, I'm going to break HISTORY.rst out into a sub-directory of its own to make changelog management significantly simpler. Refs sigmavirus24gh-806
1 parent aa50e04 commit 623086b

38 files changed

+96
-225
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
*.pyc
22
*.swp
33
docs/_build
4+
docs/build
45
bin/
56
include/
67
lib/

docs/Makefile

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

docs/project_changelog.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/source/api-reference/index.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
===============
2+
API Reference
3+
===============
4+
5+
.. toctree::
6+
:maxdepth: 1
7+
8+
api
9+
auths
10+
events
11+
gists
12+
git
13+
github
14+
issues
15+
notifications
16+
orgs
17+
pulls
18+
repos
19+
search_structs
20+
structs
21+
users
22+
23+
24+
Internals
25+
=========
26+
27+
.. toctree::
28+
:maxdepth: 1
29+
30+
decorators
31+
models
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)