You've already forked gnatstudio
mirror of
https://github.com/AdaCore/gnatstudio.git
synced 2026-02-12 12:42:33 -08:00
30f6902681
Add missing styles. * docgen.jpg: Add an example of docgen output. * gps.texi: Add a more complete description of the default tags, as well as an example. * doc.py: Adapt this example to the new docgen module. * docgen_base_tags.py: Improve display of parameters. Minor corrections and documentation completion for HB07-009 git-svn-id: svn+ssh://svn.eu/Dev/trunk/gps@132507 936e1b1b-40f2-da11-902a-00137254ae57
24 lines
815 B
Python
24 lines
815 B
Python
## This is an example of how documentation can be generated in batch mode.
|
|
## Assuming you want to generate documentation for project My_Project located
|
|
## in /foo/bar, just issue the following command:
|
|
##
|
|
## $ gps -P /foo/bar/my_project.gpr --load=python:doc.py
|
|
|
|
from GPS import *
|
|
from pygps import delayed_exit
|
|
|
|
def on_gps_started (hook):
|
|
# Set the preferences. You can adjust them at your convenience.
|
|
Preference ("Doc-Process-Body").set (True)
|
|
Preference ("Doc-Show-Private").set (True)
|
|
Preference ("Doc-References").set (True)
|
|
Preference ("Doc-Up-To-Date-Only").set (False)
|
|
|
|
# Generate documentation for the root projects and all subprojects.
|
|
Project.root().generate_doc (recursive=True)
|
|
|
|
# Try to exit every 10 seconds.
|
|
delayed_exit (10000)
|
|
|
|
GPS.Hook ("gps_started").add (on_gps_started)
|