search

hitblast / avro.py

⚡ A modern Pythonic implementation of Avro Phonetic.
https://pypi.org/project/avro.py
MIT License
13 stars 4 forks source link

Try to add an actual documentation? #38

Open baseplate-admin opened 3 weeks ago

baseplate-admin commented 3 weeks ago

The next step for this project is to add actual documentation explaining how things work.

There are 2 (actually 3) paths to take:

  1. sphinx
  2. mkdocs
  3. bring-your-own-documentation-framework

Personally i use sphinx for everything. It's very easy to setup.

hitblast commented 2 weeks ago

Sphinx is actually great in my opinion, have used it professionally for some of my projects before, but didn't think of adding it to avro.py. Could be a nice addition.

baseplate-admin commented 2 weeks ago

The only problem i have with sphinx is it's lackluster theme.

Like material for mkdocs chokhe lagse :|

hitblast commented 2 weeks ago

The only problem i have with sphinx is it's lackluster theme.

Like material for mkdocs chokhe lagse :|

I'll have a look.

baseplate-admin commented 2 weeks ago

https://squidfunk.github.io/mkdocs-material/