Documentation in html

[epogrebnyak]

That for putting up and updating the package. Have you thought of html version of documentation, possibly with sphinx?

[domokane]

I don't really know sphinx. I initially liked the idea of a pdf file that I could customize so I built some code in docs to create that. If it's not too hard or if someone else wants to add it, I would include it.

[nhaga]

Jupyterbook mught be a good solution. You basically just build normal notebooks, create a TOC file and it will generate the HTML. Then, by setting up GitHub Actions, the output can be automatically published on each update

[epogrebnyak]

Just to note - Jupyterbook itself is built around sphinx, it uses sphinx to build documentation with a special parser to process the notebooks. вт, 23 февр. 2021 г., 12:02 David Duarte <[email protected]>:

…

Jupyterbook mught be a good solution. You basically just build normal notebooks, create a TOC file and it will generate the HTML. Then, by setting up GitHub Actions, the output can be automatically published on each update — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#71 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACGWBLRNOVTR7TUQNWK4OZDTANVJHANCNFSM4X742AJQ> .

[epogrebnyak]

I don't really know sphinx. I initially liked the idea of a pdf file that I could customize so I built some code in docs to create that. If it's not too hard or if someone else wants to add it, I would include it.

The promise of sphinx is that you can generate both html documentation and the pdf file as it was usual in early days of python.

I think adding html documentation is a great benefit for a user, but it may also expose more things that might need change or polishing.

Let me try to generate some sphinx docs for the package and put a link here to judge if they are useful.

[epogrebnyak]

Superseded by #83