feat(docs): Add library documentation #12
Conversation
A basic docs implementation using Mk Docs, there's still a hand full of issues needing to be fixed but the basics are there.
|
The library does not mkdocs' syntax to document stuff, it uses Sphinx syntax. Also can you not copypaste docs stuff from hikari, like you did with |
No problem there, luckily it seems like the handler for doc strings supports using reStructuredText.
Yea, no problem, I was just working out some stuff using it, but I do plan to rewrite it or remake it entirely before this pr is anywhere near ready. (I should have made that clear before, sorry.) |
|
I've got MkDocs properly rendering the docstrings for the most part, but there are a few things that'll need some basic fixes (e.g. using mkdocstring's references style) but that's nothing I can't easily clean up. Before I work on that, though, I'll rewrite Here are two examples of those small issues I'll need to fix: |
Yeah, the library uses a lot of Sphinx-specific things, such as admonitions. As such I'll likely close this PR and make docs using Sphinx instead. |
|
I'm a little confused on why you list hikari.py in #1 as what I was doing would have brought this project's docs mostly inline with what Hikari does. I'd recommend being a bit clearer in what you want, so people don't feel like their efforts were undermined due to a lack of communication. |
|
What I meant in original issue is writing docs itself, not a poll about choosing static site generator (Sphinx, mkdocs). |
This draft aims to implement basic but useful auto-generated documentation using MkDocs and mkdocstrings.
I'm, still working on getting some markdown features to work, but in the meantime feel free to give any input on changes you'd like!
Closes #1 if merged.