Documentation updates for #205 and #208

vberlier / mudkip

A friendly Sphinx wrapper.

https://vberlier.github.io/mudkip/

MIT License

9 stars 2 forks source link

Documentation updates for #205 and #208 #209

Closed epogrebnyak closed 2 years ago

epogrebnyak commented 2 years ago

New text:

section on mudkip name
override option as conf.py replacement
pydata and latex presets
must restart the live server for deep changes
install dev version from git
link to own docs folder as an index.md example

Suggested changes on existing text:

use case without hyphen
reworded xml preset decription (avoid implying specific SSG)

I tried prefix the commits with docs but succeeded just partially.

README.md linted with prettier for consistent formatting.

vberlier commented 2 years ago

I'm really grateful for your eager contribution but I think I'd prefer handling this myself knowing that I'll probably want to refactor things along the way. You're already doing more than enough reporting all these issues. Give me a few days to wrap up what I'm currently working on and I'll start addressing them one by one :)

epogrebnyak commented 2 years ago

@vberlier - anything else I can do for mudkip?

vberlier commented 2 years ago

Turns out I'm still quite busy unfortunately. I'll also take some vacation soon so it will probably take a couple weeks before I can focus on this.