search

opera-adt / COMPASS

COregistered Multi-temPorAl Sar Slc
Apache License 2.0
38 stars 18 forks source link

Setup documentation using mkdocs #133

Closed scottstanie closed 1 year ago

scottstanie commented 1 year ago

you can test it out by installing the extra reqs in docs/requirements.txt and then running mkdocs serve

image

image

TODO: setup the readthedocs.com stuff so it'll get automatically built (I might need someone's permissions)

vbrancat commented 1 year ago

I am not sure why but the Codacy Static Code Analysis is trapped in the spinning wheel of death >.<

scottstanie commented 1 year ago

that is weird... it finished on their site https://app.codacy.com/gh/opera-adt/COMPASS/pullRequest?prid=11516990

Also, I believe that one we merge this, we can add it to readthedocs.com using https://docs.readthedocs.io/en/stable/intro/getting-started-with-mkdocs.html "import project". We'll probably have to pick some other name besides "compass.readthedocs.io" because it's taken https://compass.readthedocs.io/zh/latest/

scottstanie commented 1 year ago

i tried removing it from the .gitignore just to bump codacy.

Also i didn't write in the PR header: the setup for the docs now is following recommendations from Diátaxis documentation framework. it's what numpy/other big python projects use to structure docs, and I haven't seen any better suggestions for splitting up documentation pages.

vbrancat commented 1 year ago

@LiangJYu and @seongsujeong would be great if one of you has time to look at this PR