Skip to content

Commit

Permalink
Sync lockss-rtd-portal and lockss-rtd-manual.
Browse files Browse the repository at this point in the history
  • Loading branch information
thibgc committed Apr 2, 2024
1 parent 5a74655 commit 83f90ae
Show file tree
Hide file tree
Showing 5 changed files with 78 additions and 23 deletions.
32 changes: 25 additions & 7 deletions docs/_static/css/lockss.css
Original file line number Diff line number Diff line change
@@ -1,13 +1,31 @@
/* See https://docs.readthedocs.io/en/stable/guides/remove-edit-buttons.html#remove-on-section-from-versions-menu */
div.rst-versions > div.rst-other-versions > div.injected > dl:nth-child(1) { /* Versions */
/* Adapted from https://docs.readthedocs.io/en/stable/guides/remove-edit-buttons.html#remove-on-section-from-versions-menu */
div.rst-other-versions > dl:nth-child(3) { /* On Read the Docs */
display: none;
}
div.rst-versions > div.rst-other-versions > div.injected > dl:nth-child(2) { /* Downloads */
display: block;
}
div.rst-versions > div.rst-other-versions > div.injected > dl:nth-child(3) { /* On Read the Docs */
div.rst-other-versions > dl:nth-child(4) { /* On GitHub */
display: none;
}
div.rst-versions > div.rst-other-versions > div.injected > dl:nth-child(4) { /* On GitHub */
div.rst-other-versions > dl:nth-child(5) { /* Read The Docs based search box */
display: none;
}

/* Add border around sphinx_design tab groups to make them more legible in the larger page flow */
.sd-tab-set {
padding: 5px;
border: solid lightgray 1px;
}
.sd-tab-content {
box-shadow: none;
}

/* Insipid */
.relbar, .relbar > a:hover .direction {
color: #666;
}
.relbar .icon, nav.crumbs, #topbar, #titlebar a, #titlebar a:visited {
color: #333;
}
.nav-icon, .nav-icon:visited {
color: #666;
}

42 changes: 33 additions & 9 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@
copyright = '2000-2024, LOCKSS Program'
author = 'LOCKSS Program'

# See https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_title
html_title = project

# -- General configuration ---------------------------------------------------

Expand All @@ -71,6 +73,9 @@

# See https://sphinx-design.readthedocs.io/
'sphinx_design',

# See https://github.com/missinglinkelectronics/sphinxcontrib-globalsubs
'sphinxcontrib.globalsubs',
]

intersphinx_mapping = {
Expand All @@ -93,16 +98,16 @@
# a list of builtin themes.
#
#html_theme = 'alabaster'
# See https://sphinx-rtd-theme.readthedocs.io/
html_theme = 'sphinx_rtd_theme'
# See https://sphinx_rtd_theme.readthedocs.io/
#html_theme = 'sphinx_rtd_theme'
# See https://insipid-sphinx-theme.readthedocs.io/
html_theme = 'insipid'

# 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']

html_extra_path = ['dev/apis/EXTRA']

# See https://docs.readthedocs.io/en/stable/guides/adding-custom-css.html
html_css_files = [
'css/lockss.css',
Expand All @@ -119,19 +124,38 @@
# See https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#confval-prev_next_buttons_location
'prev_next_buttons_location': 'both',
# See https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#confval-collapse_navigation
'collapse_navigation': False,
#'collapse_navigation': False,
# See https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#confval-navigation_depth
'navigation_depth': -1,
#'navigation_depth': -1,
# See https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#confval-style_external_links
'style_external_links': True,
#'style_external_links': True,
# See https://insipid-sphinx-theme.readthedocs.io/en/latest/configuration.html#theme-option-breadcrumbs
'breadcrumbs': True,
# See https://insipid-sphinx-theme.readthedocs.io/en/latest/configuration.html#theme-option-strip_section_numbers
'strip_section_numbers': False,
}

# See https://insipid-sphinx-theme.readthedocs.io/en/0.4.2/configuration.html#theme-option-left_buttons
html_context = {
'display_github': False,
}

# See https://sphinx-tabs.readthedocs.io/
sphinx_tabs_disable_tab_closing = True
# See https://insipid-sphinx-theme.readthedocs.io/en/0.4.2/configuration.html#confval-html_show_sourcelink
html_show_sourcelink = False

# See https://insipid-sphinx-theme.readthedocs.io/en/latest/configuration.html#configuration
html_permalinks_icon = '#'

# See https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#default-substitutions
# and https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-today_fmt
today_fmt = '%Y-%m-%d'

# See https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-smartquotes
smartquotes = False

# See https://insipid-sphinx-theme.readthedocs.io/en/0.4.2/configuration.html#example
html_use_index = False
html_domain_indices = False

html_extra_path = ['dev/apis/EXTRA']

1 change: 0 additions & 1 deletion docs/front-page.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,3 @@
:color: secondary
:expand:

----
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ LOCKSS Documentation Portal
:caption: Navigation
:hidden:

LOCKSS Web Site <https://www.lockss.org/>
LOCKSS Program Web Site <https://www.lockss.org/>
» LOCKSS Documentation Portal <https://docs.lockss.org/>
LOCKSS Community Wiki <https://github.com/lockss/community/wiki>
LOCKSS Community Discussions <https://github.com/lockss/community/discussions>
24 changes: 19 additions & 5 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2000-2022, Board of Trustees of Leland Stanford Jr. University
# Copyright (c) 2000-2024, Board of Trustees of Leland Stanford Jr. University
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
Expand Down Expand Up @@ -29,19 +29,33 @@
# Sphinx itself
# https://pypi.org/project/Sphinx/
# https://www.sphinx-doc.org/
sphinx
sphinx==7.2.6

# Docutils
# https://pypi.org/project/docutils/
docutils==0.20.1

# The Sphinx theme by Read The Docs
# https://pypi.org/project/sphinx-rtd-theme/
# https://sphinx-rtd-theme.readthedocs.io/
sphinx-rtd-theme
sphinx-rtd-theme==2.0.0

# The Insipid Sphinx theme
# https://pypi.org/project/insipid-sphinx-theme/
# https://insipid-sphinx-theme.readthedocs.io/
insipid-sphinx-theme==0.4.2

# The sphinxcontrib.email extension, to obfuscate mailto links
# https://pypi.org/project/sphinxcontrib-email/
# https://github.com/sphinx-contrib/email
sphinxcontrib-email
sphinxcontrib-email==0.3.6

# The sphinx_design extension, to make grids, cards, dropdowns, tabs, badges, buttons, icons
# https://pypi.org/project/sphinx_design
# https://sphinx-design.readthedocs.io/
sphinx_design
sphinx_design==0.5.0

# The Sphinx Global Substitutions extension
# https://pypi.org/project/sphinxcontrib-globalsubs/
# https://github.com/missinglinkelectronics/sphinxcontrib-globalsubs
sphinxcontrib-globalsubs==0.1.1

0 comments on commit 83f90ae

Please sign in to comment.