Merge pull request 'Docs: Change docs README for new way of building docs' (#448) from ilja/akkoma:improve_readme_from_docs into develop

Reviewed-on: AkkomaGang/akkoma#448

.gitignore

@@ -73,6 +73,7 @@ pleroma.iml
 
 # Generated documentation
 docs/site
+docs/venv
 
 # docker stuff
 docker-db

Makefile

@@ -1,7 +0,0 @@
-all:	install
-	pipenv run mkdocs build
-
-install:
-	pipenv install
-clean:
-	rm -rf docs

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
+# Run an http server who rebuilds when files change
-pip install pipenv
+# Accessable on http://127.0.0.1:8000
-pipenv sync
+mkdocs serve
+
+# 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
+
+# To get out of the virtual environment, you do
+deactivate
 ```
-
-#### 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
-
-```shell
-[pipenv run] make all
-```
-
-#### 4. Serve the files
-
-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
-```
-
-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>