abraker95 / ultimate_osu_analyzer

Python rewrite of my old osu analyzer that aims to be a lot more useful
MIT License
28 stars 1 forks source link

Read the Docs Documentation #30

Open abraker95 opened 4 years ago

abraker95 commented 4 years ago

Github wiki are a bit limited in regards to formatting. Read the Docs seems to be cleaner and offer better ways to document various features (and automatic documentation from source code)

Made doc here: https://ultimate-osu-analyzer.readthedocs.io/en/latest/

Follow this when documenting: https://python-docs.readthedocs.io/en/latest/writing/documentation.html