search

Lakemonsters2635 / MonsterDocs

MIT License
0 stars 1 forks source link

Index - Needs work #13

Open jwaltner opened 1 month ago

jwaltner commented 1 month ago

the index.rst needs some work so that we have sections and the logical groups have group headings. Someone needs to head-up learning RST format and getting us a good start on MonsterDocs formatting.

jwaltner commented 1 month ago

@SahanRULES , please figure out how to do section breaks in the index for MonsterDocs. My initial guess on how to do that with captions was wrong.

jwaltner commented 1 month ago

Also please figure out how we do previews of these docs so we do not need to develop off of main to preview. @venomboss985 , just tagging you for awareness on this, if you know how to do this, please let us know.

SahanRULES commented 4 weeks ago

For preview of docs use a pre-release version (you can change this in vs code extensions) of the esbonio extension https://docs.esbon.io/en/latest/. Also, there needs to be a python interpreter integrated into the vs code project. It does not seem to work with the readTheDocs theme, however by publishing the page on github we can always check.

esbonioExtension

SahanRULES commented 4 weeks ago

The section breaks have been added on the branch sectionBreaks which is of dev. The problem was the spacing because the caption does not appear if there is a line break in between the :maxdepth: and the :caption:

sectionBreak Screenshot 2024-10-26 203306

jwaltner commented 3 weeks ago

@SahanRULES , thank you for figuring out how to fix the index. This makes the docs a lot better. I have gone ahead and merged your updates into the main and that automatically built the new version of the docs. I will checkout that preview as well.

jwaltner commented 3 weeks ago

Item moved to In Review while I review the preview item. Thanks for that as well.