Working on updating Manual #3
Conversation
|
I sadly cannot (yet) replicate the presentation on the user par of the manual. Would a presentation change be a no-go?
|
|
I'm wait to push your pr. |
|
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 |
|
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: ***@***.***>
|
I've got it working by using the sphinx-design extension so no custom html that could break. Yay!
|
|
@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?pid=17250#p17250 |
|
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 |
|
Automatic page building now works! as for the REUSE action if you see recent failed deployments, it is normal it fails if no file have been changed |
|
@scorpio810 what is the ACTUAL version number of the doc? |
|
There was never a version number for the documentation, it was just based on version 0.7 of QET. |
|
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? |
|
Yes it's make sense. |
|
@scorpio810 Could you perhaps ask some contributors like @plc-user or others to check if the docs are missing some implemented features pls? |
|
Hello @Int-Circuit! Most of my commits work in the background not to be seen by users, but some are quite visible:
All these changes are for the version 0.10-dev of QET! |
|
Hello @Int-Circuit! |
|
Hello Laurent,
Thanks for that,
The doc isn't yet completelly ironed out but that's a start and this step will help with that.
When it's done I will give you help on how to setup the automatic deployment of the doc with github.
The only thing we would need would be a subdomain that you control (example doc.qelectrotech.org) so that github can push the files to that adress, but thats for some time in the future.
Le 7 mars 2025 11:05:27 GMT+01:00, Laurent Trinques ***@***.***> a écrit :
…scorpio810 left a comment (qelectrotech/qelectrotech-doc#3)
Hello @Int-Circuit!
I've compiled the html pages of the manual and made them available here for QET's users to comment on.:
[Manual_new](https://download.qelectrotech.org/qet/manuals/html/index.html)
--
Reply to this email directly or view it on GitHub:
#3 (comment)
You are receiving this because you were mentioned.
Message ID: ***@***.***>
|
|
Hi, thanks for the feedback, it helps a lot,
The big problem is that the doc dates back to qet 0.7 and that there isn't a lot of explanations about the new added features and how they work (as someone who is external to the dev of the app)
Could you perhaps give me bulletpoints about 0.8 and 0.9, since 0.10 is still considered beta?
Thanks
Le 7 mars 2025 10:42:55 GMT+01:00, plc-user ***@***.***> a écrit :
…plc-user left a comment (qelectrotech/qelectrotech-doc#3)
Hello @Int-Circuit!
Most of my commits work in the background not to be seen by users, but some are quite visible:
- implement settable point-size of grid (1 .. 5)
- element editor: add mirror (shortcut: <M>) and flip (shortcut: <F>) for all primitives
- element-editor: add rotation with smaller increments (5 degrees) for "line", "polygon", "text" and "dynamic_text" with shortcut <Ctrl>+<Space>
- element-editor: fix rotation by 90° of primitives (shortcut: <Space>)
- element-editor: copy-and-paste: set paste-position to meaningful values
- export: set maximum width / height according limitations in QPainter to 32767 for Pixel-Images and 100000 for svg/dxf (was set to 10000 before globally for all types of export)
- use QET_ElementScaler from Element-Editor - GUI
- add "Company-Collection" and "Company-Titleblocks" (can be used like customer-collection and customer-titleblocks)
All these changes are for the version 0.10-dev of QET!
--
Reply to this email directly or view it on GitHub:
#3 (comment)
You are receiving this because you were mentioned.
Message ID: ***@***.***>
|
|
There are some threads in QET-Forum, where differences between versions are noted: |
|
Hi @scorpio810, could you please tell me where the source for the Doxygen files are, I am trying to integrate them in the dev docs. |
Hi @Int-Circuit source for Doxygen are here: |
|
Hello @scorpio810 could you please review the doxygen MR on the QET source repo? |
Update gh-reuse.yml to correctly account if no changes Update gh-reuse.yml to take note of continue-on-fail on previous step fixed position of if Update gh-reuse.yml Changed from activating on push to activating on pull request + removed unnecessary if no change step as the continue-if-fail instruction allow to skip got step if source files haven't had a change added po files to translate + towncrier config to auto generate changelog of doc added PO files
removed autochangelog to future MR + rework image dir
testing changes to fix CI excluding conf.py file fixed path of source files in codespell step added fix for codespell added Test of path for codespell changes to codespell fixing errors in CI
… from devs regarding action fixing typos and formatting
added checkout reenabled typo checker skip svg files fixed path to check spelling fixed typos in previous chapters
…Spell errors still shown but deploy anyway - Continue to fix errors in docs Switch to always in action removed always use correct continue on error parameter fixing quotes in skipped files param fix quotes fixing globs
remove broken translations remove more translations added doxygen job to page setup added sanity check commented prod command added wait on page job corrected path on artifact added test doxygen forgot to point to test branch use git switch instead of checkout switch correct directory fix artifact directory check xml dir return to origin path added absolute path dir check switch to prebuilt action remove workspace path correct doxyfile placement fix file name added file passing to jobs
fixed spelling : final
removed old code added branch build removed need doxygen
deploy on push fix for action switch to ubuntu-latest since 20.04 isn't available anymore
remove breathe added correct codespell skip glob fix space in spell step
fix reuse error fix commit message
fail on spell error fix warn
- translated images + translation in future MR
3 participants
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
Update
Maintain
Bugfix