B-AROL-O / ARNEIS

Automated Recognizer, Network-Enabled, Items Sorter
https://arneis.readthedocs.io
MIT License
21 stars 8 forks source link

[Feat] New document hierarchy #313

Closed alv67 closed 2 years ago

alv67 commented 2 years ago

Closes #134

📑 Description

Restructured the TOC in the index.rst, this can produce a better PDF.

✅ Checks

ℹ Additional Information

alv67 commented 2 years ago

@gmacario please check all the Chapter introduction text, and propose a better version. This is introduced since in the PDF chapter without will not be well formatted.

gmacario commented 2 years ago

@gmacario please check all the Chapter introduction text, and propose a better version. This is introduced since in the PDF chapter without will not be well formatted.

Thanks @alv67, I checked the preview page on https://arneis--313.org.readthedocs.build/en/313/ and it looks quite good to me. My only concern is about the contents in section "How-to Guides" as well as in section "LEGO®"

image

I wonder whether it would be possible - instead of placing all the items on the same line - to list each HOWTO under a separated bulleted item, like for instance

Second question: I understand this is nitpick, but do you think it is not avoidable to have to duplicate the list of pages (one in the bulleted list, the other in the "toc" section") in docs/index.rst?

alv67 commented 2 years ago

Second question: I understand this is nitpick, but do you think it is not avoidable to have to duplicate the list of pages (one in the bulleted list, the other in the "toc" section") in docs/index.rst?

That is the trick to force the creation of correct PDF. Too long to explain, I will show you if you want.

@gmacario please check and merge.