Reference

Origen Web

• Build the webpages:

  origen web build

• Build the webpages and launch your browser to view the results:

  origen web build --view

• Clean the artifacts of a previous run, rebuild the webpages, and launch your browser:

  origen web build --clean --view

Run origen web --help or see the origen web section for further details.

Origen’s Shorthand Defs

Origen includes a set of Shorthand Defs (namespaced as origen) for quick referencing to common places your application documentation may point to, especially where new-user or installation guides are concerned:

 {'abslinks': {'core': {'core_team': ('Origen core team',
                                    'https://github.com/orgs/Origen-SDK/teams/core'),
                      'github_home': ('Origen Github project',
                                      'https://github.com/Origen-SDK/o2'),
                      'issues': ('Origen issues page',
                                 'https://github.com/Origen-SDK/o2/issues'),
                      'project_tracker': ("Origen's project tracker",
                                          'https://github.com/Origen-SDK/o2/projects')},
             'guides': {'api': ('Origen API',
                                'https://origen-sdk.org/o2/interbuild/autoapi/origen/origen'),
                        'documenting': 'https://origen-sdk.org/o2/guides/documenting',
                        'logger': 'https://origen-sdk.org/o2/guides/runtime/utilities/logger',
                        'pattern_api': 'https://origen-sdk.org/o2/guides/testers/pattern_generation/pattern_api',
                        'program_api': 'https://origen-sdk.org/o2/guides/testers/program_generation/program_api'},
             'home': 'https://origen-sdk.org/o2',
             'so_tag': ('Origen stack overflow',
                        'https://stackoverflow.com/questions/tagged/origen-sdk')},
'namespace': 'origen'}

Reference Materials

Sphinx Guides

• Sphinx Homepage

• Sphinx App

• Sphinx’s conf.py

• Sphinx Extensions

• Origen’s sphinx app

• Origen included extensions

  • Autodoc

  • AutoAPI

• The origen Sphinx Extension

• Sphinx Themes

• origen theme

Jinja

• Templating In Sphinx

• Jinja

RST Guides

• Sphinx’s RST Primer

• RST Quickstart

• RST Docs

• Other Useful RST/Sphinx Guides

  • RST guide from the Zephyr project

  • RST cheatsheet

  • RST/Sphinx cheatsheet from Thomas Cokelaer

Customizations

• Adding a favicon

• Adding logos

• Adding a subproject

• Configuration Variables

Other

• Markdown

  • Markdown Introduction

  • Recommonmark Extension

• The Napoleon Extension

  • Google Docstring Spec

  • Numpy Docstring Spec

• The Autosectionlabel Extension

  • Prefix document config