MkDocs has several plugins that could build documentation from docstrings.

I tried mkdocstrings (https://github.com/pawamoy/mkdocstrings). It doesn't 
support readthedocs theme and its parser has issues, so I was not able to 
add documentation for all modules: 
https://xuhcc.github.io/beancount-docs/api_reference/index.html 

But it is in active development and hopefully these issues will be resolved 
soon.

On Monday, May 11, 2020 at 9:32:50 AM UTC+3, Martin Michlmayr wrote:
>
> * Kirill Goncharov <[email protected] <javascript:>> [2019-08-02 02:18]: 
> > Docs now available at GitHub Pages: 
> https://xuhcc.github.io/beancount-docs/ 
>
> This is very impressive. 
>
> But afaict it doesn't have the API reference that Dominik's version 
> has. 
>
> His uses Sphinx whereas you use MkDocs. 
>
> Is there any chance we could agree one one solution and improve that 
> together? 
>
> (I noticed some formatting issues in the API reference, i.e. in the 
> docstrings.) 
> -- 
> Martin Michlmayr 
> https://www.cyrius.com/ 
>

-- 
You received this message because you are subscribed to the Google Groups 
"Beancount" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/beancount/1266795c-3882-440b-b067-9f2e1d956f09%40googlegroups.com.

Reply via email to