'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'sphinx-prompt', 'sphinxcontrib.bibtex', 'documenteer.sphinxext', 'documenteer.sphinxext.bibtex', ] html_theme = 'sphinx_rtd_theme' html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] version = form_ltd_edition_name( git_ref_name=os.getenv('TRAVIS_BRANCH', default='master')) # The full version, including alpha/beta/rc tags. release = version project = 'docsteady: Jira test document creation' html_title = project html_short_title = 'docsteady' author = 'LSST Data Management' copyright = '2017-2021 Association of Universities for Research in Astronomy (AURA), Inc.' master_doc = 'index' html_context = { # Enable "Edit in GitHub" link
# The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # The short X.Y version. github_ref = os.getenv("GITHUB_REF") if github_ref is None: with contextlib.closing(os.popen('git symbolic-ref HEAD')) as p: github_ref = p.read().strip() match = re.match(r"refs/(heads|tags|pull)/(?P<ref>.+)", github_ref) if not match: git_ref = "main" else: git_ref = match.group("ref") version = form_ltd_edition_name(git_ref) # The full version, including alpha/beta/rc tags. release = version html_last_updated_fmt = "" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # exclude_patterns = [] # The reST default role cross-links Python (used for this markup: `text`) default_role = "py:obj" # -- Options for linkcheck builder --------------------------------------------
# General information about the project. project = "LTD Conveyor" copyright = "2017-2020 Association of Universities for Research in Astronomy, Inc. (AURA)" author = "LSST Data Management" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. if os.getenv("TRAVIS_BRANCH", default="master") == "master": # Use the current release as the version tag if on master version = "Current" release = version else: # Use branch name as the version tag version = form_ltd_edition_name( git_ref_name=os.getenv("TRAVIS_BRANCH", default="master")) release = version # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: # today = '' # Else, today_fmt is used as the format for a strftime call. # today_fmt = '%B %d, %Y'
# source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = u'LSST DM Developer Guide' copyright = u'2016-2017 Association of Universities for Research in Astronomy, Inc.' author = u'LSST Data Management' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = form_ltd_edition_name( git_ref_name=os.getenv('TRAVIS_BRANCH', default='master')) # The full version, including alpha/beta/rc tags. release = version # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: # today = '' # Else, today_fmt is used as the format for a strftime call. # today_fmt = '%B %d, %Y'