updated docs

Makefile

@@ -8,30 +8,30 @@ init-submodules:
 		git checkout main && \
 		git pull && \
 		pip install poetry && \
-		poetry add pdoc3 && \
 		poetry install
 	cd ..
 
 update-submodules:
 	git submodule foreach git pull
 
 docs-install:
-	python3 -m pip install -r requirements.txt
+	pip install -r requirements.txt
 
 docs-update docs-update-deps:
-	python3 -m pip install --upgrade -r requirements.txt
+	pip install --upgrade -r requirements.txt
 
 docs-generate: 
+	rm -rf docs/code/pyaurorax_api_reference/*
 	cd pyaurorax && poetry run python3 -m pdoc --html --force --output-dir ../docs/code/pyaurorax_api_reference pyaurorax --config "lunr_search={'fuzziness': 1}"
 
 docs-build:
-	python3 -m mkdocs build
+	python -m mkdocs build
 
 docs-serve:
-	python3 -m mkdocs serve
+	python -m mkdocs serve
 
 docs-deploy:
-	python3 -m mkdocs gh-deploy --force
+	python -m mkdocs gh-deploy --force
 
 clean:
 	rm -rf site

README.md

@@ -31,7 +31,7 @@ To generate documentation for submodules. they must first be initialized and the
     $ cd pyaurorax
     $ git checkout main
     $ git pull
-    $ python3 -m pip install poetry
+    $ pip install poetry
     $ poetry install
     $ cd ..
     ```
@@ -45,7 +45,7 @@ To generate documentation for submodules. they must first be initialized and the
 4. Install mkdocs dependencies
 
     ```
-    $ python3 -m pip install -r requirements.txt
+    $ pip install -r requirements.txt
     ```
 
 5. Since the submodules in this repository are Python projects, their API references can be generated automatically using ```pdoc3```. This step generates HTML files and places them in the specified directory. The command to generate the docs is run through Poetry because the dependencies of the package were installed by Poetry in a virtual environment. This additional step ensures that each submodule maintains its own dependencies and that the documentation is generated for exactly the dependencies used by the submodule.

docs/code/installation.md

@@ -10,6 +10,7 @@ You can install PyAuroraX using pip, and import it like so:
 $ pip install pyaurorax
 $ python
 >>> import pyaurorax
+>>> aurorax = pyaurorax.PyAuroraX()
 ```
 
 More installation details can be found on the readme of the code repository [on Github](https://github.com/aurorax-space/pyaurorax){:target="_blank"}.