Skip to content

Commit

Permalink
Docs: re-enable show sourcelink, and have it point to GH (#2803)
Browse files Browse the repository at this point in the history
  • Loading branch information
wxtim authored Jul 25, 2024
1 parent 05d97e0 commit 5457809
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
12 changes: 9 additions & 3 deletions sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,13 @@


# -- Options for HTML output ----------------------------------------------

# Make sourcelink point to GH source rather than the raw source.
html_context = {
'display_github': True,
'github_user': 'metomi',
'github_repo': 'rose',
'github_version': 'master/sphinx/',
}
html_theme = 'sphinx_rtd_theme'
# rtd_theme only handles 4 levels for the sidebar navigation.
html_theme_options = {'navigation_depth': 4}
Expand Down Expand Up @@ -186,8 +192,8 @@
latex_show_pagerefs = True
# If true, show URL addresses after external links.
latex_show_urls = 'inline'
# Don't link RST source page.
html_show_sourcelink = False
# Link to RST source page.
html_show_sourcelink = True
# Add a custom css file to make tables wrap correctly.
html_css_files = ['custom.css']

Expand Down
7 changes: 0 additions & 7 deletions sphinx/index.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
.. ifnotslides::

.. raw:: html

<a href="https://github.com/metomi/rose"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/365986a132ccd6a44c23a9169022c0b5c890c387/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f7265645f6161303030302e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"></a>


Rose Documentation
==================

Expand Down

0 comments on commit 5457809

Please sign in to comment.