Creating a documentation site with mkdocs (#1)

* init mkdocs docs

* add api reference for docs

* adding logos and formatting for docs

* Add readthedocs config

* fix bug in readthedocs

* fix new bug in readthedocs

* change readthedocs dependency install method

* add site_url for readthedocs

* update README.md

* update README.md

.readthedocs.yaml

@@ -0,0 +1,35 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+  jobs:
+    post_install:
+      - pip install .[docs]
+
+# Build documentation in the "docs/" directory with Sphinx
+mkdocs:
+   configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+  - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#    install:
+#    - requirements: docs/requirements.txt

README.md

@@ -1,2 +1,49 @@
+<img src="docs/img/logo-light.png" width="300">
+
 # circumplex
- A Python port of the R Circumplex package
+
+[![PyPI version](https://badge.fury.io/py/circumplex.svg)](https://badge.fury.io/py/circumplex)
+[![Documentation Status](https://readthedocs.org/projects/circumplex/badge/?version=latest)](https://circumplex.readthedocs.io/en/latest/?badge=latest)
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+
+_circumplex_ is a Python package for analyzing and visualizing circumplex data. It provides a set of tools for analyzing and visualizing circumplex data, following the Structural Summary Method. This project is a Python implementation based on the R [circumplex](https://circumplex.jmgirard.com/) package. Our goal is to provide a similar functionality and experience for Python users.
+
+!!! note
+    This project is still under development. We're working hard to make it as good as possible, but there may be bugs or missing features. If you find any issues, please let us know by submitting an issue on Github.
+
+## Getting Started
+
+To get started with _circumplex_, you'll need to install it first. You can do this by running the following command:
+
+```bash
+pip install circumplex
+```
+
+## Documentation
+
+This documentation is designed to help you understand and use _circumplex_ effectively. It's divided into several sections:
+
+- **Tutorials**: Practical examples showing how to use our project in real-world scenarios.
+- **API Reference**: Detailed information about our project's API.
+- **Contribute**: Information on how you can contribute to our project.
+
+## Contributing
+
+We welcome contributions from the community. If you're interested in contributing, please get in touch or submit an issue on Github.
+
+## License
+
+This project is licensed under the GNU GPLv3 License. For more information, please see the `license.md` file.
+
+## Project layout
+
+    mkdocs.yml     # The configuration file.
+    docs/
+        index.md   # The documentation homepage.
+        about.md   # The about page.
+        license.md # The license page.
+        tutorials/ # Tutorial pages.
+            Introduction to SSM Analysis.ipynb  
+        ...        # Other markdown pages, images and other files.
+    src/circumplex/
+        circumplex.py 

docs/about.md

@@ -0,0 +1,39 @@
+# Recepto nimios non cupidine secus oscula timuere
+
+## Ora boumque armorum vicit quae Athamas est
+
+Lorem markdownum silva at habendum en **tristis nasci ereptaque** Romane te
+fuerit raucos **gelidus**. Levi caput superant ab facto; ac protinus avium
+latebris Thybrin, Solis et.
+
+1. Hostilia illic thalamique avido sepulcro socerum retia
+2. Quaerunt medias Aesone quas
+3. Iamque fuit et quoque protegat
+4. Est vocibus
+
+Villae intervenit recipit cruentatus vagas secretasque Cyllenius nec sinuantur
+Glauci, Thaumantidos? Curru cadunt tenebat obsessum, iuga **fortuna exspes**!
+
+## Nisi duo et titubat mihi tantum non
+
+Saepe abstrahor Periphanta quid negabat tulit naturaeque quae, [hic
+sine](http://iam.org/)! Iove mira fluxit credensque virtus, posuitque; adfore
+merces est praesens ergo, Arcas, sucus. Ad [silvae tandem
+exorata](http://agro-hoc.org/); silva hirsutus fuit Vulcanum de possit Titan
+ulciscere verus quamquam navigat quibus; pes genitor!
+
+1. Nato tamen et humana et admoneo videtur
+2. Tenebant insignia
+3. Lucifer penetralia ut illis bimembres saturata membra
+
+Victus illis! Trepidoque quid habitata, suco esse **Sibyllae** loco superata
+comitantibus illa vectus regionibus idonea arbore dextra **non** ferrum.
+
+    var newbie_pup_jumper = metafile_bank(addGateway, mipsScrollWhite.affiliate(
+            fifoBatchClean));
+    net(system, 5 - 1, cluster_icf_heap);
+    scrapingActiveBit.copyright = bookmark;
+    var drive_tutorial = frameworkSql;
+
+Et Themis uterque temptat et crimen adhibere vestem? Deus mens est pulverulenta
+*fretum* nimios pharetras suspiria alti Phrygiae potest?

docs/index.md

@@ -0,0 +1,50 @@
+![Image title](img/logo-light.png#only-light)
+![Image title](img/logo-dark.png#only-dark)
+
+# Welcome to Circumplex
+
+[![PyPI version](https://badge.fury.io/py/circumplex.svg)](https://badge.fury.io/py/circumplex)
+[![Documentation Status](https://readthedocs.org/projects/circumplex/badge/?version=latest)](https://circumplex.readthedocs.io/en/latest/?badge=latest)
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+
+_circumplex_ is a Python package for analyzing and visualizing circumplex data. It provides a set of tools for analyzing and visualizing circumplex data, following the Structural Summary Method. This project is a Python implementation based on the R [circumplex](https://circumplex.jmgirard.com/) package. Our goal is to provide a similar functionality and experience for Python users.
+
+!!! note
+    This project is still under development. We're working hard to make it as good as possible, but there may be bugs or missing features. If you find any issues, please let us know by submitting an issue on Github.
+
+## Getting Started
+
+To get started with _circumplex_, you'll need to install it first. You can do this by running the following command:
+
+```bash
+pip install circumplex
+```
+
+## Documentation
+
+This documentation is designed to help you understand and use _circumplex_ effectively. It's divided into several sections:
+
+- **Tutorials**: Practical examples showing how to use our project in real-world scenarios.
+- **API Reference**: Detailed information about our project's API.
+- **Contribute**: Information on how you can contribute to our project.
+
+## Contributing
+
+We welcome contributions from the community. If you're interested in contributing, please get in touch or submit an issue on Github.
+
+## License
+
+This project is licensed under the GNU GPLv3 License. For more information, please see the `license.md` file.
+
+## Project layout
+
+    mkdocs.yml     # The configuration file.
+    docs/
+        index.md   # The documentation homepage.
+        about.md   # The about page.
+        license.md # The license page.
+        tutorials/ # Tutorial pages.
+            Introduction to SSM Analysis.ipynb  
+        ...        # Other markdown pages, images and other files.
+    src/circumplex/
+        circumplex.py