Change docs README for new way of building docs

Docs used to be a separate repo who cloned pleroma and pelroma-fe.
Now the docs are just the BE docs and completely part of the Akkoma repo.
I moved back to using venv because that's what I used and cleaner imo since it keeps everything nice in the repo.
(Iirc virtualenv stored things in the Home folder or smthng)

diff --git a/.gitignore b/.gitignore
index 95b236af62e286baa85790f5d0b8b51d31e6c984..8821d8ce106287131f48d61fb323aef91b346956 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -73,6 +73,7 @@ pleroma.iml
 
 # Generated documentation
 docs/site
+docs/venv
 
 # docker stuff
 docker-db

diff --git a/docs/README.md b/docs/README.md
index fcf043f5619d3f2960d371c49faffffbcaa345d4..a9a17a2ab2066e6722c9cd60c3c0bf858551da3a 100644 (file)
--- a/docs/README.md
+++ b/docs/README.md
@@ -2,33 +2,27 @@
 
 You don't need to build and test the docs as long as you make sure the syntax is correct. But in case you do want to build the docs, feel free to do so.
 
-You'll need to install mkdocs for which you can check the [mkdocs installation guide](https://www.mkdocs.org/#installation). Generally it's best to install it using `pip`. You'll also need to install the correct dependencies.
+```sh
+# Make sure you're in the same directory as this README
+# From the root of the Akkoma repo, you'll need to do
+cd docs
 
-### Example using a Debian based distro
+# Optionally use a virtual environment
+python3 -m venv venv
+source venv/bin/activate
 
-#### 1. Install pipenv and dependencies
+# Install dependencies
+pip install -r requirements.txt
 
-```shell
-pip install pipenv
-pipenv sync
-```
-
-#### 2. (Optional) Activate the virtual environment
-
-Since dependencies are installed in a virtual environment, you can't use them directly. To use them you should either prefix the command with `pipenv run`, or activate the virtual environment for current shell by executing `pipenv shell` once.
-
-#### 3. Build the docs using the script
+# Run an http server who rebuilds when files change
+# Accessable on http://127.0.0.1:8000
+mkdocs serve
 
-```shell
-[pipenv run] make all
-```
-
-#### 4. Serve the files
+# Build the docs
+# The static html pages will have been created in the folder "site"
+# You can serve them from a server by pointing your server software (nginx, apache...) to this location
+mkdocs build
 
-A folder `site` containing the static html pages will have been created. You can serve them from a server by pointing your server software (nginx, apache...) to this location. During development, you can run locally with
-
-```shell
-[pipenv run] mkdocs serve
+# To get out of the virtual environment, you do
+deacivate
 ```
-
-This handles setting up an http server and rebuilding when files change. You can then access the docs on <http://127.0.0.1:8000>