Docs: Change docs README for new way of building docs #448

ilja · 2023-01-26T08:13:19Z

ilja commented

2023-01-26 08:13:19 +00:00

As the title says.

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)
It's also much shorter now :)

As the title says. 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) It's also much shorter now :)

ilja changed title from ~~Change docs README for new way of building docs~~ to Docs: Change docs README for new way of building docs

2023-01-26 09:14:11 +00:00

ilja force-pushed improve_readme_from_docs from be383c1ba5 to 2044994de1

2023-01-26 13:12:11 +00:00

Compare

ilja force-pushed improve_readme_from_docs from 2044994de1 to e74e1efe1c

2023-01-26 14:43:06 +00:00

Compare

floatingghost reviewed 2023-01-26 16:04:08 +00:00

floatingghost left a comment

seems ok, might be worth noting that there is a makefile, so make will also "just work" once the deps are installed

seems ok, might be worth noting that there is a makefile, so `make` will also "just work" once the deps are installed

docs/README.md Outdated

					
				@ -30,2 +26,2 @@

				```shell

				[pipenv run] mkdocs serve

				# To get out of the virtual environment, you do

				deacivate

floatingghost commented

2023-01-26 16:03:48 +00:00

typo, deactivate

typo, `deactivate`

ilja commented

2023-01-28 14:07:52 +00:00

Checking the Makefile brings up three questions for me;

I see the Makefile uses pipenv, so it won't work with the way I did it (as it won't find pipenv). Do you prefer I change the README back to using pipenv? Or is it enough to just point out the Makefile is there and people can figure it out themself by reading the file?

I see make serve uses python's http.server. I'm not sure when exactly you use this, but if it's just for when you're working on the docs, mkdocs serve is probably better because it also rebuilds when you change things. I can change it too if you want? Ofc, maybe automatic rebuilding isn't something you always want, so idk.

I also notice now that there's a Makefile in the root of the project referring to mkdocs. Is that something that's also used? https://akkoma.dev/AkkomaGang/akkoma/src/branch/develop/Makefile

Checking the Makefile brings up three questions for me; I see the Makefile uses pipenv, so it won't work with the way I did it (as it won't find pipenv). Do you prefer I change the README back to using pipenv? Or is it enough to just point out the Makefile is there and people can figure it out themself by reading the file? I see `make serve` uses python's http.server. I'm not sure when exactly you use this, but if it's just for when you're working on the docs, `mkdocs serve` is probably better because it also rebuilds when you change things. I can change it too if you want? Ofc, maybe automatic rebuilding isn't something you always want, so idk. I also notice now that there's a Makefile in the root of the project referring to mkdocs. Is that something that's also used? https://akkoma.dev/AkkomaGang/akkoma/src/branch/develop/Makefile

floatingghost commented

2023-01-30 11:25:05 +00:00

ah yeah the one in the root isn't supposed to be there

in that case this should be fine

just the typo to fix then i guess

ah yeah the one in the root isn't supposed to be there in that case this should be fine just the typo to fix then i guess

ilja added 1 commit 2023-02-02 13:38:37 +00:00

typo + remove unneeded file

ci/woodpecker/pr/woodpecker Pipeline is pending

Details

7f8932304f

ilja commented