docs update

[rachmadaniHaryono]

• update for documentation using sphinx
• package is based from poetry
• modules is based from sphinx-apidoc
• python file is formatted with darker

related #484 (comment)

> # install required package
> pip install -e ".[docs]"
> # clone buku wiki
> git clone https://github.com/jarun/buku.wiki.git docs/source/wiki
> # build documentation
> sphinx-build docs/source build
> xdg-open build/index.html

---

i said to try mkdocs but there is also problem with it

https://github.com/rachmadaniHaryono/Buku/tree/feature/mkdocs

i haven't going too deep to it but i may not continue it if sphinx can be used

i still don't know how to upload it to github page or readthedocs

[froschdesign]

i still don't know how to upload it to github page…

No "upload" needed: https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site

[rachmadaniHaryono]

@froschdesign thanks for that

i tried it once again manually and it work https://rachmadaniharyono.github.io/Buku/index.html

after set up gh-branch, move build files to that branch and commit it as usual

maybe there is better way to run it automatically with github action

[froschdesign]

maybe there is better way to run it automatically with github action

https://github.com/marketplace?type=actions&query=sphinx+

[rachmadaniHaryono]

i only tried this and failed https://github.com/marketplace/actions/sphinx-to-github-pages

i still have to try others on that list

[jarun]

Please let me know when it's ready and I'll merge.

[rachmadaniHaryono]

@jarun it is ready

github action can be added on another pr

[jarun]

Thank you!