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.

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

Cleanup documentation #885

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions doc/admin/admin-upgrade.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _admin-upgrade:

Instructins for upgrading Qserv to newer releases
=================================================
Instructions for upgrading Qserv to newer releases
==================================================

.. _admin-upgrade-mariadb-11-4-4:

Expand Down
12 changes: 3 additions & 9 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,14 @@

from documenteer.sphinxconfig.utils import form_ltd_edition_name

# Add any paths that contain templates here, relative to this directory.
templates_path = ["templates"]

# 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:
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:
Expand All @@ -36,17 +33,14 @@
# Add any URL patterns to ignore (e.g. for private sites, or sites that
# are frequently down).
linkcheck_ignore = [
r"^https://jira.lsstcorp.org/browse/",
r"^https://jira.lsstcorp.org/",
r"^https://dev.lsstcorp.org/trac",
r"^https://confluence.lsstcorp.org/display/",
r"^https://rubinobs.atlassian.net/wiki/",
r"^https://rubinobs.atlassian.net/browse/",
r"^https://www.slac.stanford.edu/",
r".*/_images/",
r"^https://dev.mysql.com/doc/refman/",
]

html_additional_pages = {
"index": "overview.html"
}

mermaid_version = "10.3.0"
7 changes: 0 additions & 7 deletions doc/reference/contents.rst

This file was deleted.

16 changes: 0 additions & 16 deletions doc/reference/glossary.rst

This file was deleted.

Loading