StarlingUAS / ProjectStarling

BRL Flight Arena Infrastructure 2.0
Other
16 stars 3 forks source link

Create Documentation #28

Closed mhl787156 closed 3 years ago

mhl787156 commented 3 years ago

Create a docs page and link into build system: https://docs.readthedocs.io/en/stable/intro/import-guide.html

mhl787156 commented 3 years ago

Note Read the docs only works for public facing repositories. So either we create our own server, or we ask users to host locally if they need documentation.

mhl787156 commented 3 years ago

The documentation will be local documentation not hosted anywhere. The user is expected to build the documentation themselves.

rob-clarke commented 3 years ago

https://www.mkdocs.org/user-guide/deploying-your-docs/#github-pages

mhl787156 commented 3 years ago

@rob-clarke could you set up readthedocs: https://readthedocs.org/ as you need admin rights to set up the webhook! This method might be simplier than github-pages with the organisation stuff.