For more information about using Sphinx, visit the following page.
To generate documentation, change into the folder containing the sphinx files and execute commands:
>>> make clean >>> make html
To update the documentation on the website (sourceforge), you have to log in with your login sourceforge SFTP or via a GUI as FileZilla or WinSCP or command line. Files specific to Web pages must be stored into the folder /home/project-web/gwa/htdocs/. This folder is not visible with ls command, you must return to it directly, either via GUI or command line. A small example:
[user@linux ~]$ sftp email@example.com Connecting to web.sourceforge.net... The authenticity of host 'web.sourceforge.net (188.8.131.52)' can't be established. RSA key fingerprint is b0:a8:eb:30:ce:1a:0e:6a:4d:7a:6b:3a:0a:c6:27:60. Are you sure you want to continue connecting (yes/no)? yes Warning: Permanently added 'web.sourceforge.net,184.108.40.206' (RSA) to the list of known hosts. firstname.lastname@example.org's password: sftp> cd /home/project-web/gwa/htdocs sftp> put index.html Uploading index.html to /home/project-web/gwa/htdocs/index.html index.html 100% 241 0.2KB/s 00:01 sftp> exit
Several types of code files are present in this project:
- the entry point of the program: main.py
- files that manage activities in the GUI: code_*.py
- the different modules of the folder “code”
At the root of the project and in the folder “code” a file __init__.py is present. This is an entry point to folder that can manage import in code files.
When installing GWA, the PYTHONPATH is exported. For example, if GWA is installed in /opt/gwa/, /opt/ will be added to PYTHONPATH. Therefore, simply make a import gwa to import the entire library GWA, or import gwa.code_mesure.py to import only this file or import gwa.code.DBA to import the file located in the folder “code”.