Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to documenteer guide doc build #1089

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Switch to documenteer guide doc build #1089

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0b2fec2
Switch to documenteer guide doc build
timj Apr 8, 2024
549c51d
Enable bibtex in guide
timj Apr 8, 2024
f48d6d7
Fix label in example memo
timj Apr 8, 2024
87be160
Mask readme from sphinx build
timj Apr 8, 2024
f28da7b
Remove trailing whitespace
timj Apr 8, 2024
0aeea5f
Fix Jira ticket URL
timj Apr 8, 2024
5aae5be
Fix black formatting
timj Apr 8, 2024
93b379a
Remove some trailing whitespace
timj Apr 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 9 additions & 68 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,76 +3,17 @@
# Sphinx configuration file
# see metadata.yaml in this repo for to update document-specific metadata

import os

import sphinx_rtd_theme
from documenteer.sphinxconfig.utils import form_ltd_edition_name


extensions = [
'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='main'))
# The full version, including alpha/beta/rc tags.
release = version

project = 'lsst-texmf: The LSST LaTeX Classes'
html_title = project
html_short_title = 'lsst-texmf'

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
'display_github': True,
'github_user': 'lsst',
'github_repo': 'lsst-texmf',
# TRAVIS_BRANCH is available in CI, but main is a safe default
'github_version': os.getenv('TRAVIS_BRANCH', default='main') + '/docs/'
}

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = '_static/lsst-logo-dark.svg'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

templates_path = ['_templates']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['README.rst', '_build']

source_encoding = 'utf-8'
from documenteer.conf.guide import * # noqa
timj marked this conversation as resolved.
Show resolved Hide resolved

# BibTeX configuration
bibtex_bibfiles = [
'../texmf/bibtex/bib/lsst.bib',
'../texmf/bibtex/bib/books.bib',
'../texmf/bibtex/bib/lsst-dm.bib',
'../texmf/bibtex/bib/refs.bib',
'../texmf/bibtex/bib/refs_ads.bib',
"../texmf/bibtex/bib/lsst.bib",
"../texmf/bibtex/bib/books.bib",
"../texmf/bibtex/bib/lsst-dm.bib",
"../texmf/bibtex/bib/refs.bib",
"../texmf/bibtex/bib/refs_ads.bib",
]

# Intersphinx configuration.
# http://www.sphinx-doc.org/en/stable/ext/intersphinx.html
intersphinx_mapping = {}
# Feel free to experiment with other options
bibtex_default_style = "lsst_aa"
bibtex_reference_style = "author_year"
14 changes: 14 additions & 0 deletions docs/documenteer.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[project]
title = "lsst-texmf: The LSST LaTeX Classes"
copyright = "2016-2024 Association of Universities for Research in Astronomy, Inc. (AURA)"
base_url = "https://lsst-texmf.lsst.io"
github_url = "https://github.com/lsst/lsst-texmf"

[sphinx]
extensions = [
"sphinxcontrib.bibtex",
"documenteer.ext.bibtex",
]
timj marked this conversation as resolved.
Show resolved Hide resolved
exclude = [
"_templates/README.md" # This markdown file is not part of the documentation
]
2 changes: 1 addition & 1 deletion docs/examples/MEMO-nnn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _DMTN-nnn:
.. _MEMO-nnn:

################################
Memo example - use any series
Expand Down
3 changes: 1 addition & 2 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
documenteer>=0.6,<1.0
documenteer[guide]
sphinx-rtd-theme==0.2.4
sphinx-prompt
sphinx <7
12 changes: 6 additions & 6 deletions texmf/bibtex/bib/books.bib
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,12 +360,12 @@ @Book{1982mmme.book.....B
}


@BOOK{NAP26141,
author = "National Academies of Sciences, Engineering and Medicine",
title = "Pathways to Discovery in Astronomy and Astrophysics for the 2020s",
isbn = "978-0-309-46734-6",
doi = "10.17226/26141",
abstract ="We live in a time of extraordinary discovery and progress in astronomy and astrophysics. The next decade will transform our understanding of the universe and humanity's place in it. Every decade the U.S. agencies that provide primary federal funding for astronomy and astrophysics request a survey to assess the status of, and opportunities for the Nation's efforts to forward our understanding of the cosmos. Pathways to Discovery in Astronomy and Astrophysics for the 2020s identifies the most compelling science goals and presents an ambitious program of ground- and space-based activities for future investment in the next decade and beyond. The decadal survey identifies three important science themes for the next decade aimed at investigating Earth-like extrasolar planets, the most energetic processes in the universe, and the evolution of galaxies. The Astro2020 report also recommends critical near-term actions to support the foundations of the profession as well as the technologies and tools needed to carry out the science.",
@BOOK{NAP26141,
author = "National Academies of Sciences, Engineering and Medicine",
title = "Pathways to Discovery in Astronomy and Astrophysics for the 2020s",
isbn = "978-0-309-46734-6",
doi = "10.17226/26141",
abstract ="We live in a time of extraordinary discovery and progress in astronomy and astrophysics. The next decade will transform our understanding of the universe and humanity's place in it. Every decade the U.S. agencies that provide primary federal funding for astronomy and astrophysics request a survey to assess the status of, and opportunities for the Nation's efforts to forward our understanding of the cosmos. Pathways to Discovery in Astronomy and Astrophysics for the 2020s identifies the most compelling science goals and presents an ambitious program of ground- and space-based activities for future investment in the next decade and beyond. The decadal survey identifies three important science themes for the next decade aimed at investigating Earth-like extrasolar planets, the most energetic processes in the universe, and the evolution of galaxies. The Astro2020 report also recommends critical near-term actions to support the foundations of the profession as well as the technologies and tools needed to carry out the science.",
url = "https://nap.nationalacademies.org/catalog/26141/pathways-to-discovery-in-astronomy-and-astrophysics-for-the-2020s",
year =2021,
publisher = "The National Academies Press",
Expand Down
2 changes: 1 addition & 1 deletion texmf/bibtex/bib/refs.bib
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2311,7 +2311,7 @@ @MISC{FIPS200

@MISC{TCISSG,
publisher = {The NSF Cybersecurity Center of Excellence},
author = {Andrew Adams and Kay Avila and Elisa Heymann and Mark Krenz and Jason R. Lee and
author = {Andrew Adams and Kay Avila and Elisa Heymann and Mark Krenz and Jason R. Lee and
Barton P. Miller and Sean Peisert
},
title = {Guide to Securing Scientific Software },
Expand Down
14 changes: 7 additions & 7 deletions texmf/tex/latex/lsst/lsstdoc.cls
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,22 +403,22 @@

\newcommand{\mkmemotitle}{
\thispagestyle{empty}
\newgeometry{top= 1cm,left=2cm,bottom=1cm, right=2cm}
\newgeometry{top= 1cm,left=2cm,bottom=1cm, right=2cm}
\vspace*{-30pt}

\includegraphics[width=4cm]{rubin_logo}
\hfill
\begin{minipage}{0.3\textwidth}
\begin{flushright}
\vspace*{-50pt}
\large
\large
950 North Cherry Avenue,
Tucson, AZ, 85719.
\vspace{3mm}
\textbf{\docDate}
\textbf{\docDate}
\end{flushright}
\end{minipage}

\vspace{10pt}
\textbf {To: \memoto}\\
\textbf {From: \@author}\\
Expand Down Expand Up @@ -1109,8 +1109,8 @@ No actions have been identified.}
% -----------------------------------------------------------------------------
% Useful definition
% -----------------------------------------------------------------------------
\def\VRO{Vera C. Rubin Observatory~}
\def\RO{Rubin Observatory~}
\def\VRO{Vera C. Rubin Observatory~}
\def\RO{Rubin Observatory~}
\def\aaps{A\&AS} % Astronomy and Astrophysics Suplement
\def\aap{A\&A} % Astronomy and Astrophysics
\def\ssr{Space~Sci.~Rev.} % Space Science Reviews
Expand Down Expand Up @@ -1392,7 +1392,7 @@ No actions have been identified.}
\newcommand{\reqparam}[1]{\margin@req{#1}}

% Reference a JIRA ticket
\newcommand{\jira}[1]{\href{https://jira.lsstcorp.org/browse/#1}{#1}}
\newcommand{\jira}[1]{\href{https://rubinobs.atlassian.net/browse/#1}{#1}}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Expand Down
Loading