Dear Christian, You’re most welcome. If you need a reviewer, just let me know. I’d try my best. I’d love to assist in updating them, but life keeps me busy beyond reason currently. Cheers, Hakan
On 23 Aug 2022, at 17:17, c.buhtz@posteo.jp wrote:
Dear Hakan,
thanks a lot for that. Seems quit easy because of the make-setup.
In that case I will try to improve the doc strings step by step while investigating the project's code.
Kind Christian
Am 23.08.2022 15:18 schrieb Hakan Bayındır:
Hi Christian, I'm attaching a compressed version of the documents I have just generated. It's turned out to be actually pretty simple. For further reference, it can be done as follows. 1. You need to have python3-sphinx package installed for Debian. 2. Checkout to code. 3. Navigate to common/doc-dev 4. Call "make html". It'll create the documents under "_build" folder. Open "_build/html/index.html", and you're done. If you wish, I can setup a pipeline which can pull the repo once a week, generate the documents and put somewhere online. I also use Vagrant extensively, and can create an automated document generator VM and share here, too. Cheers, Hakan On 22.08.2022 16:03, c.buhtz@posteo.jp wrote:
Hello together, it seems that BIT does use Sphinx. I can see the reStructuredText in the codes docstrings. But I can't find the HTML docu generated from that docstrings. Not sure what the correct term is here for documentation that was generated out of docstrings: "Reference"? Does anyone know if there is such a docu? If not is anyone able to generate such a docu quick and dirty from the current main branch and can send it to me or somewhere else? It doesn't have to go into the official repo yet. It just would help me a lot to better understand the code and the structure of the project. I have used Sphinx a bit but I'm not quit familiar with it. And I won't touch Sphinx. ;) Btw: I am aware of the separate docu repo: https://github.com/bit-team/doc But it seems to me that this only is kind of a "User manual" and does not reference to the code. Kind Christian _______________________________________________ Bit-dev mailing list -- bit-dev@python.org To unsubscribe send an email to bit-dev-leave@python.org https://mail.python.org/mailman3/lists/bit-dev.python.org/ Member address: hakan@bayindir.org
Bit-dev mailing list -- bit-dev@python.org To unsubscribe send an email to bit-dev-leave@python.org https://mail.python.org/mailman3/lists/bit-dev.python.org/ Member address: hakan@bayindir.org