Skip to content

Commit d589129

Browse files
authored
docs: enable build documentation by readthedocs service (#144)
1 parent f0f47e0 commit d589129

File tree

6 files changed

+29
-52
lines changed

6 files changed

+29
-52
lines changed

.readthedocs.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
version: 2
2+
3+
build:
4+
os: ubuntu-22.04
5+
tools:
6+
python: "3.10"
7+
8+
mkdocs:
9+
configuration: docs/mkdocs.yml
10+
11+
python:
12+
install:
13+
- requirements: docs/requirements.txt

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!--home-start-->
12
<p align="center">
23
<img src="https://github.com/InfluxCommunity/influxdb3-python/blob/main/python-logo.png?raw=true" alt="Your Image" width="150px">
34
</p>
@@ -48,7 +49,7 @@ Note: This does not include Pandas support. If you would like to use key feature
4849
*Note: Please make sure you are using 3.6 or above. For the best performance use 3.11+*
4950

5051
# Usage
51-
One of the easiest ways to get started is to checkout the ["Pokemon Trainer Cookbook"](Examples/pokemon-trainer/cookbook.ipynb). This scenario takes you through the basics of both the client library and Pyarrow.
52+
One of the easiest ways to get started is to checkout the ["Pokemon Trainer Cookbook"](https://github.com/InfluxCommunity/influxdb3-python/blob/main/Examples/pokemon-trainer/cookbook.ipynb). This scenario takes you through the basics of both the client library and Pyarrow.
5253

5354
## Importing the Module
5455
```python
@@ -213,3 +214,4 @@ pip install -e .[pandas,polars,dataframe,test]
213214
# Run the tests
214215
python -m pytest .
215216
```
217+
<!--home-end-->

docs/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{%
2+
include-markdown "../README.md"
3+
start="<!--home-start-->"
4+
end="<!--home-end-->"
5+
%}

docs/mkdocs.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
site_name: InfluxDB 3.0 Python Client
2+
docs_dir: .
3+
nav:
4+
- Home: index.md
5+
plugins:
6+
- include-markdown

docs/readme.md

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

docs/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
mkdocs
2+
mkdocs-include-markdown-plugin

0 commit comments

Comments
 (0)