Skip to content

Commit

Permalink
Customise config
Browse files Browse the repository at this point in the history
  • Loading branch information
tmihoc committed Aug 12, 2024
1 parent 1b26bc3 commit 1665504
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@
############################################################

# Product name
project = 'Documentation starter pack'
project = 'Juju'
author = 'Canonical Ltd.'

# The title you want to display for the documentation in the sidebar.
# You might want to include a version number here.
# To not display any title, set this option to an empty string.
html_title = project + ' documentation'
html_title = project + '3.5 documentation'

# The default value uses CC-BY-SA as the license and the current year
# as the copyright year.
Expand Down Expand Up @@ -52,7 +52,7 @@
## when linking to the documentation from another website (see https://ogp.me/)
# The URL where the documentation will be hosted (leave empty if you
# don't know yet)
ogp_site_url = 'https://canonical-starter-pack.readthedocs-hosted.com/'
ogp_site_url = 'https://canonical-juju.readthedocs-hosted.com/'
# The documentation website name (usually the same as the product name)
ogp_site_name = project
# The URL of an image or logo that is used in the preview
Expand All @@ -70,7 +70,7 @@
# For example: "ubuntu.com/lxd" or "microcloud.is"
# If there is no product website, edit the header template to remove the
# link (see the readme for instructions).
'product_page': 'documentation.ubuntu.com',
'product_page': 'juju.is',

# Add your product tag (the orange part of your logo, will be used in the
# header) to ".sphinx/_static" and change the path here (start with "_static")
Expand All @@ -80,19 +80,19 @@
# Change to the discourse instance you want to be able to link to
# using the :discourse: metadata at the top of a file
# (use an empty value if you don't want to link)
'discourse': 'https://discourse.ubuntu.com',
'discourse': 'https://discourse.charmhub.io',

# Change to the Mattermost channel you want to link to
# (use an empty value if you don't want to link)
'mattermost': 'https://chat.canonical.com/canonical/channels/documentation',
'mattermost': '',

# Change to the Matrix channel you want to link to
# (use an empty value if you don't want to link)
'matrix': 'https://matrix.to/#/#documentation:ubuntu.com',
'matrix': 'https://matrix.to/#/#charmhub-juju:ubuntu.com',

# Change to the GitHub URL for your project
# This is used, for example, to link to the source files and allow creating GitHub issues directly from the documentation.
'github_url': 'https://github.com/canonical/sphinx-docs-starter-pack',
'github_url': 'https://github.com/juju/docs',

# Change to the branch for this version of the documentation
# 'github_version': 'main',
Expand Down

0 comments on commit 1665504

Please sign in to comment.