From 9fc23f434823cf15198a073f2aac32fa1548aaca Mon Sep 17 00:00:00 2001 From: Jonathan Herrewijnen Date: Sun, 15 Oct 2023 22:14:56 +0200 Subject: [PATCH] Initial commit. Adding docs --- .gitignore | 1 + README.md | 8 +++++++- docs/conf.py | 4 ++++ herrewebpy/__init__.py | 1 + readthedocs.yml | 3 +++ 5 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 .gitignore create mode 100644 docs/conf.py create mode 100644 herrewebpy/__init__.py create mode 100644 readthedocs.yml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..eba74f4 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +venv/ \ No newline at end of file diff --git a/README.md b/README.md index 1ec77a6..6e2d047 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ # HerrewebPy -Python pakket voor Herreweb \ No newline at end of file +Python package for Herreweb. + +``` +python -m venv venv +source venv/bin/activate # On Windows: venv\Scripts\activate +pip install sphinx sphinx-rtd-theme sphinxcontrib-napoleon +``` \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..c191f60 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,4 @@ +# docs/conf.py +extensions = [ + 'myst_parser', +] diff --git a/herrewebpy/__init__.py b/herrewebpy/__init__.py new file mode 100644 index 0000000..b974282 --- /dev/null +++ b/herrewebpy/__init__.py @@ -0,0 +1 @@ +from . import * \ No newline at end of file diff --git a/readthedocs.yml b/readthedocs.yml new file mode 100644 index 0000000..4e368dd --- /dev/null +++ b/readthedocs.yml @@ -0,0 +1,3 @@ +version: 2 +sphinx: + configuration: docs/conf.py