Skip to content

Commit f1813f3

Browse files
committed
Docs README as index
1 parent e663aae commit f1813f3

File tree

4 files changed

+30
-4
lines changed

4 files changed

+30
-4
lines changed

.readthedocs.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,6 @@ mkdocs:
2121

2222
# Optionally declare the Python requirements required to build your docs
2323

24-
#python:
25-
# install:
26-
# - requirements: docs/requirements.txt
24+
python:
25+
install:
26+
- requirements: docs/requirements.txt

docs/index.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{!README.md!}
2+
3+
# Passio Go API Documentation
4+
5+
This is an unofficial library for Passio Go.
6+
7+
```
8+
pip install passiogo
9+
```
10+
11+
## Bug Reporting / Feedback
12+
13+
Found a bug? Have an idea for a new feature? Please [send it in as a GitHub issue](https://github.com/athuler/PassioGo/issues)!
14+
15+
16+
## Contributing
17+
18+
Interested in contributing to this package? [Fork the repository](https://github.com/athuler/PassioGo/fork), make your edits, then open a pull request!

docs/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
markdown>=3.3
2+
markdown-include>=0.6.0

mkdocs.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,10 @@ site_author: Andrei Thüler
88
nav:
99
- Home: index.md
1010
- Usage: usage.md
11-
- API Reference: api.md
11+
- API Reference: api.md
12+
13+
#plugins:
14+
# - search
15+
markdown_extensions:
16+
- markdown_include.include:
17+
base_path: .

0 commit comments

Comments
 (0)