1 (edited by fdomateu 2020-03-22 00:42:49)

Topic: Documentation QElectroTech 0.7

Hello,

The documentation from QElectroTech 0.7 has been updated at github. The modifications are:

  • Documentation re-structured to minimize the size using common figures.

  • Official icons added in the images.

  • Documentation ready for internationalization, file structure and new filename definition (figure_languge_filename = "{path}{language}/{basename}{ext}") for the automatic selection of figures depending on the language.

  • New theme used (sphinxbootstrap4theme).

  • Forum and Home page links added to the documentation menu.

  • Some grammatical corrections.

  • Some new information added

  • pdf version created and download link added to index page.

Re: Documentation QElectroTech 0.7

Hi Fernando,

good work, thanks.
The Online documentation from QElectroTech 0.7 has been synced.

Re: Documentation QElectroTech 0.7

Thanks a lot for this good work.

Re: Documentation QElectroTech 0.7

Great, many thanks nomicons/smile

Re: Documentation QElectroTech 0.7

fdomateu wrote:

Hello.

The translation is working according to the lazy text from python. On
github you will find the basic chapter in spanish as an example at the
locale/es/LC_MESSAGES folder. You should copy the project source folder and
follow the steps from *sphinx-intl*. The instructions can be found at the
link  copied below and the *conf.py* file of the project is already
prepared for that.

https://www.sphinx-doc.org/en/master/us … d/intl.htm

To also get the images in the final language, you should create the images
from the folder images/en/ in the desired language, if the images from the
english version are not created they will not be shown in the final
documentation. You will also find some examples in Spanish.

At the end of your job, we would appreciate that the final source code from
your folder locale/*xx*/LC_MESSAGES and the image folder are added to the
source repository of the project. These are the folders that the
QElectroTech team has to receive to include in the official github
repository.

Best regards

Re: Documentation QElectroTech 0.7

Hello,

The documentation master branch has been prepared for the version 0.8, the changes already made have been indicated at ChangeLof file from the source directory. The html files from the build directory have also been updated.

The added information has been taken from the ChangeLog of QElectroTech source mirror

I would appreciate any comment to focus the time on the issues you consider more important/interesting.

Note: The pdf manual version has also been updated for downloading

Re: Documentation QElectroTech 0.7

Great, Thanks Fernando

I synced new changes:

rsync -e ssh -av --delete-after --no-owner --no-g --chmod=g+w --progress /media/backup6/download/qelectrotech-doc/build/  johndoe@ssh.tuxfamily.org:/home/qet/qet-repository/manual_0.7/build/

Re: Documentation QElectroTech 0.7

Is it not better to keep the version 0.7 at directory 0.7 and add a new directory named manual_0.8? or, an idea that i like more, publish two different versions of documentation:
- Latest release (currently 0.7)
- Develop version (currently 0.8)

The 0.7 version can be found at branch 0.7.1 from github and the master branch is the latest (develop version).

Additionally, i would like to inform that the build files from tuxfamily are actually mixed. You can find some html from QElectroTech 0.8 documentation and some  of them from QElectroTech 0.7 documentation

Re: Documentation QElectroTech 0.7

Additionally, i would like to inform that the build files from tuxfamily are actually mixed. You can find some html from QElectroTech 0.8 documentation and some  of them from QElectroTech 0.7 documentation

F5 for refresh.


If I change directory to  manual_0.8 I need to change URL in QET code, but user use old version don't see new manual.

Re: Documentation QElectroTech 0.7

It will push them to switch to the new version. :p

Re: Documentation QElectroTech 0.7

Thanks for the F5 input.

Nevertheless, some images have not been uploaded from github. For example, downloading the github master banch as zip, I see all images from type of elements sub-files. At the tuxfamily source I am not getting the files in the documents. At preferences chapter I also see the same issue

I do not know if there is any problem during syncronization or at the server, downloading as zip from github all is inside and working

Re: Documentation QElectroTech 0.7

Images is on build folder, yes?
And yes I use git pull and after rsync

I try with Github tarball.

Re: Documentation QElectroTech 0.7

F5, I synced with Github tarball.

Thanks for the tip to tarball.

Re: Documentation QElectroTech 0.7

scorpio810 wrote:
fdomateu wrote:

Hello.

The translation is working according to the lazy text from python. On
github you will find the basic chapter in spanish as an example at the
locale/es/LC_MESSAGES folder. You should copy the project source folder and
follow the steps from *sphinx-intl*. The instructions can be found at the
link  copied below and the *conf.py* file of the project is already
prepared for that.

https://www.sphinx-doc.org/en/master/us … d/intl.htm

To also get the images in the final language, you should create the images
from the folder images/en/ in the desired language, if the images from the
english version are not created they will not be shown in the final
documentation. You will also find some examples in Spanish.

At the end of your job, we would appreciate that the final source code from
your folder locale/*xx*/LC_MESSAGES and the image folder are added to the
source repository of the project. These are the folders that the
QElectroTech team has to receive to include in the official github
repository.

Best regards

You could add Spanish index.html link in main page?

Re: Documentation QElectroTech 0.7

Perfect,

Now the documentation is updated.

I have seen that at the end you have updated to manual link text from the forum to the documentation, perfect detail

Re: Documentation QElectroTech 0.7

I also replaced Arun old documentation 0.4 in main page site by new 0.8 version of manual.

Re: Documentation QElectroTech 0.7

Maybe to be added in documentation

https://qelectrotech.org/forum/viewtopi … 5584#p5584