From 403ac01e89241141c06c08b0123268603719875a Mon Sep 17 00:00:00 2001 From: Boyan <boyan@confest.im> Date: Tue, 13 Feb 2024 20:35:26 +0100 Subject: [PATCH] Update README. Started docs. --- .readthedocs.yaml | 11 +++++++++++ README.md | 7 ++++--- 2 files changed, 15 insertions(+), 3 deletions(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..05333ca --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,11 @@ +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + +sphinx: + configuration: docs/conf.py diff --git a/README.md b/README.md index 47be25e..71bc66f 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,11 @@ A python library which interacts with themis. Use selenium and bs4. I'll try to ## Intended Features * [x] Log in - -To log in, go to the `config.py` file and replace the username and password field with yours. You can now continue to use the rest of the library. * [ ] Classes, methods and attributes described in the map below - + +## Docs +[here](http://temmies.rtfd.io/). Heavily WIP. + ## Class map 