GDA Developer Guide Logo
9.40
  • 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.6. Adding a new section to the document
    • 1.7. Creating content in markdown
    • 1.8. Use of custom CSS
    • 1.9. Using Visual Paradigm
    • 1.10. Auto generation of Class and Sequence diagrams
    • 1.11. Documentation Makefile and Scripts
    • 1.12. Python Scripts autodoc
    • 1.13. UML Diagram Notation
  • 2. Introduction to the GDA
  • 3. GDA Installation
  • 4. Gerrit Setup
  • 5. GDA Start-up
  • 6. Jython Script types
  • 7. Writing new Device classes in Jython and Java
  • 8. Client GUI development
  • 9. Remoting
  • 10. GDA Configuration
  • 11. User Messages
  • 12. Integrating EPICS in GDA
  • 13. EPICS AreaDetector Viewer
  • 14. New Scanning
  • 15. Malcolm
  • 16. NeXus File Writing
  • 17. Build and Infrastructure
  • 18. GDA Demo
  • 19. Developing GDA
  • 20. Key Patterns
  • 21. Writing & Running GDA Test Code
  • 22. GDA on MX Beamlines
  • 23. GDA on VMXi Beamline
  • 24. GDA Use Cases
  • 25. Frequently Asked Questions
  • 26. Contributors to the GDA project
  • Python Code
  • Document’s Broken Links
Index
GDA Developer Guide
  • »
  • 1. About this document »
  • 1.3. External links to source code documentation
  • View page source

1.3. External links to source code documentation¶

Both the Developer and User Guides contain external web-links to source code documentation relevant to the software being discussed (e.g. Javadoc). These are highlighted in the text using the following formatting:

  • Diamond Confluence - web-link ending with Confluence favicon, e.g. Data Acquisition Home

  • Gerrit - web-link ending with Gerrit favicon, e.g. gda-documentation

  • GitHub - web-link ending with GitHub cat, e.g. DawnScience/dawnsci

  • Javadoc - web-link ending with Java coffee-cup, e.g. Scannable

  • SourceForge - web-link ending with external arrow icon, e.g. EpicsResources

The formatting of the above links is provided by CSS code and uses the contents of the web-link to determine whether the specific formatting is to be applied, e.g. the Javadoc formatting is applied to all web-links that contain the text javadocs. In addition to the image, for all but Diamond Confluence links, the link text is formatted using a monospace font, in blue and underlined. Therefore the documentation writer should not apply any formatting to the text of the link other than use of bold, italics, or other formatting that will not obscure the formatting provided by the CSS code (e.g. use of monospace to format the code of the link text will obscure the underline).

The custom CSS code is contained in the file gda-documentation/common/_static/cutom.css, for more information regarding this see Use of custom CSS.

Icons used for GitHub, Javadoc and SourceForge links obtained from icons8.com.

Next Previous

© Copyright 2011-2025, Diamond Light Source | Document generated at 21:28 09-12-2025

Built with Sphinx using a theme provided by Read the Docs.