Skip to content

Commit

Permalink
Various cosmetic improvements to the manual
Browse files Browse the repository at this point in the history
  • Loading branch information
Kodiologist committed Apr 10, 2024
1 parent c697da0 commit d970001
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 24 deletions.
13 changes: 13 additions & 0 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
div.body, div.footer, code, div.code-block-caption,
div.body h1, div.body h2, div.body h3, div.body h4, div.body h5, div.body h6,
a.toc-backref
{color: black}

div.body p, div.body dd, div.body li, div.body blockquote
{hyphens: manual}

a
{color: navy}
a:visited
{color: purple}

5 changes: 0 additions & 5 deletions docs/_templates/breadcrumbs.html

This file was deleted.

24 changes: 8 additions & 16 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,19 @@
# Read the Docs might dirty its checkout, so strip the dirty flag.
hy_version = re.sub(r"[+.]dirty\Z", "", hy_version)

templates_path = ["_templates"]
html_theme = "nature"
html_theme_options = dict(
nosidebar = True,
body_min_width = 0,
body_max_width = 'none')
html_css_files = ['custom.css']
source_suffix = ".rst"

master_doc = "index"
html_title = f'Hy {hy_version} manual'

# General information about the project.
project = "hy"
project = "Hy"
copyright = "%s the authors" % time.strftime("%Y")

# The version info for the project you're documenting, acts as replacement for
Expand All @@ -48,13 +54,6 @@
exclude_patterns = ["_build", "coreteam.rst"]
add_module_names = True

pygments_style = "sphinx"

import sphinx_rtd_theme

html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# 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".
Expand All @@ -76,10 +75,3 @@

import hy
hy.I = type(hy.I) # A trick to enable `hy:autoclass:: hy.I`


# ** Sphinx App Setup


def setup(app):
app.add_css_file("overrides.css")
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The Hy Manual
=============
Contents
========

.. image:: _static/hy-logo-small.png
:alt: Hy
Expand Down
1 change: 0 additions & 1 deletion requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ pytest >= 7
# documentation
Pygments @ git+https://github.com/Kodiologist/pygments@hylex
Sphinx == 5.0.2
sphinx_rtd_theme == 1.2.2
git+https://github.com/hylang/sphinxcontrib-hydomain.git

0 comments on commit d970001

Please sign in to comment.