1. About this document

• 1.1. Introduction
• 1.2. GDA single-point-of-truth
• 1.3. External links to source code documentation
• 1.4. Obtaining and updating the documentation source
• 1.5. Building the GDA Developer and User Guides at Diamond
  • 1.5.1. Create Python virtual environment
  • 1.5.2. Build the documentation
• 1.6. Adding a new section to the document
• 1.7. Creating content in markdown
  • 1.7.1. Markdown source style guide
  • 1.7.2. Embedding reStructuredText
  • 1.7.3. Creating large tables
  • 1.7.4. Indexing and searching
• 1.8. Use of custom CSS
  • 1.8.1. Image display customization
  • 1.8.2. Hyper-links to external sites
• 1.9. Using Visual Paradigm
  • 1.9.1. VP User Interface Nomenclature
  • 1.9.2. Using VP at Diamond
    • 1.9.2.1. Installing VP
    • 1.9.2.2. Updating VP version
      • 1.9.2.2.1. Hotfix
      • 1.9.2.2.2. New Version
    • 1.9.2.3. VP License Selection
    • 1.9.2.4. Changing the VP License Selected
  • 1.9.3. VP GUI application vs Command-line
  • 1.9.4. Application Options
    • 1.9.4.1. Project Options
  • 1.9.5. Importing Java source code into Visual Paradigm
    • 1.9.5.1. VP Project Browser gotcha
  • 1.9.6. Adding imported classes to model
  • 1.9.7. Class Diagrams
  • 1.9.8. Sequence Diagrams
  • 1.9.9. Python ‘Class’ Diagrams - Relation Diagrams
• 1.10. Auto generation of Class and Sequence diagrams
  • 1.10.1. Auto generated Class Diagrams vs Visual Paradigm application created Class Diagrams
  • 1.10.2. Configuring Class and Sequence Diagram auto-creation
  • 1.10.3. GenerateCD Visual Paradigm plug-in
    • 1.10.3.1. VP plug-ins
      • Constant Field Values
    • 1.10.3.2. GenerateCD VP plug-in implementation and installation
      • 1.10.3.2.1. How to build and install plug-in
        • 1.10.3.2.1.1. Javadoc
        • 1.10.3.2.1.2. Clean
  • 1.10.4. How to use diagram auto-creation
    • 1.10.4.1. Quick start guide
    • 1.10.4.2. Slower start guide
• 1.11. Documentation Makefile and Scripts
  • 1.11.1. Makefiles
    • 1.11.1.1. Common Makefile targets
      • 1.11.1.1.1. help and helpfull
      • 1.11.1.1.2. clean
      • 1.11.1.1.3. html
      • 1.11.1.1.4. b_links
      • 1.11.1.1.5. b_links_external
      • 1.11.1.1.6. b_links_local
    • 1.11.1.2. GDA Developer Guide Makefile targets
      • 1.11.1.2.1. help
      • 1.11.1.2.2. html
      • 1.11.1.2.3. full
      • 1.11.1.2.4. vp_plugins
      • 1.11.1.2.5. vp_plugins_docs
      • 1.11.1.2.6. vp_plugins_clean
      • 1.11.1.2.7. create_dia
    • 1.11.1.3. GDA User Guide Makefile targets
  • 1.11.2. Scripts
    • 1.11.2.1. Common Scripts
      • 1.11.2.1.1. create_broken_links_md.py
    • 1.11.2.2. GDA Developer Guide Scripts
      • 1.11.2.2.1. extractPyDocs.py
      • 1.11.2.2.2. extractPyClasses.sh
      • 1.11.2.2.3. findDeviceClassesInUse.py
      • 1.11.2.2.4. updateModelsAndClassDiagrams.sh
      • 1.11.2.2.5. VisParMaker.py
      • 1.11.2.2.6. vp_create_models_and_diagrams.py
• 1.12. Python Scripts autodoc
  • 1.12.1. Common Scripts
    • 1.12.1.1. create_broken_links_md
  • 1.12.2. GDA Developer Guide Scripts
    • 1.12.2.1. extractPyDocs
    • 1.12.2.2. findDeviceClassesInUse
    • 1.12.2.3. VisParMaker
    • 1.12.2.4. vp_create_models_and_diagrams
• 1.13. UML Diagram Notation