*DRAFT, DO NOT MERGE YET* Working on updating Manual

[Int-Circuit]

Why

The QelectroTech manual hasn't been updated for V0.9 and lacks any developer info (build/test the app). This MR hopes to correct this.

Summary

This MR has three axes:

Simplify

• Switched from using bootstap4 theme to furo sphinx theme. Reason is that the former isn't updated anymore. The latter is updated, is used for the python + pip doc (its reliable) and has built-in support for dark theme.
• Use sphinx-design extension to simplify appearance of welcome page.
• Create a (proprer) directory structure to switch from a messy structure to an organized one (especially for images)

Update

• Added Dev docs on how to build the app
• Added GitHub CI to automaticaly build, publish and licence files on push/merge/ pull request to branch. Using Sphinx-note's page action
• Added app changelog in developper/app_changelog.rst + Documentation changelog

Maintain

• Update User docs
• Update low-res icons/images

[Int-Circuit]

I sadly cannot (yet) replicate the presentation on the user par of the manual. Would a presentation change be a no-go?

[scorpio810]

I'm wait to push your pr.
Thanks @Integrat-edCircuit ;-)

[scorpio810]

if documentation were easier to translate, it would be a great improvement

[Int-Circuit]

if documentation were easier to translate, it would be a great improvement

It requires sadly to have the doc being rewritten in the corresponding language. Not an easy process. If I have some time, I'm gonna sse if there is a possibility to do som CI magic to use a libretranslate instance to do the job

[scorpio810]

https://qelectrotech.org/forum/viewtopic.php?pid=15771#p15771

[Int-Circuit]

Interesting, I will see if it's possible to interface both of the systems Le 20 juillet 2024 17:03:16 GMT+02:00, Laurent Trinques ***@***.***> a écrit :

…

https://qelectrotech.org/forum/viewtopic.php?pid=15771#p15771 -- Reply to this email directly or view it on GitHub: #3 (comment) You are receiving this because you were mentioned. Message ID: ***@***.***>

[Int-Circuit]

I sadly cannot (yet) replicate the presentation on the user par of the manual. Would a presentation change be a no-go?

I've got it working by using the sphinx-design extension so no custom html that could break. Yay!

[Int-Circuit]

@scorpio810 is there something that changed meaningfully between 0.8 (last up to date version of the doc) and 0.9 that I would need to add/edit?

[scorpio810]

@scorpio810 is there something that changed meaningfully between 0.8 (last up to date version of the doc) and 0.9 that I would need to add/edit?

@Integrat-edCircuit :See
https://qelectrotech.org/forum/viewtopic.php?id=1953
https://qelectrotech.org/forum/viewtopic.php?id=2379

https://qelectrotech.org/forum/viewtopic.php?pid=17250#p17250

[scorpio810]

https://github.com/qelectrotech/qelectrotech-source-mirror/blob/master/ChangeLog

[scorpio810]

yes, I know it's a lot of work to edit, but you don't have to, otherwise thank you very much in advance.

[Int-Circuit]

yes, I know it's a lot of work to edit, but you don't have to, otherwise thank you very much in advance.

Thx for linking me to that, regarding what I was talking onto our forum thread, what do you think about

[Int-Circuit]

@scorpio810 what is the ACTUAL version number of the doc?

[scorpio810]

There was never a version number for the documentation, it was just based on version 0.7 of QET.

[Int-Circuit]

OK. Im currently implementing an autochangelog system for the doc + source code. Does it makes sense to say that the doc was at version 0.1 for qet 0.7?

[scorpio810]

Yes it's make sense.