-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #54 from ru-fu/split-config
split the configuration file into common and custom
- Loading branch information
Showing
3 changed files
with
240 additions
and
145 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| import datetime | ||
|
|
||
| # Custom configuration for the Sphinx documentation builder. | ||
| # All configuration specific to your project should be done in this file. | ||
| # | ||
| # The file is included in the common conf.py configuration file. | ||
| # You can modify any of the settings below or add any configuration that | ||
| # is not covered by the common conf.py file. | ||
| # | ||
| # For the full list of built-in configuration values, see the documentation: | ||
| # https://www.sphinx-doc.org/en/master/usage/configuration.html | ||
|
|
||
| ############################################################ | ||
| ### Project information | ||
| ############################################################ | ||
|
|
||
| # Product name | ||
| project = 'Documentation starter pack' | ||
| author = 'Canonical Group Ltd' | ||
|
|
||
| # Uncomment if your product uses release numbers | ||
| # release = '1.0' | ||
|
|
||
| # The default value uses the current year as the copyright year | ||
| copyright = '%s, %s' % (datetime.date.today().year, author) | ||
|
|
||
| ## Open Graph configuration - defines what is displayed in the website preview | ||
| # The URL of the documentation output | ||
| ogp_site_url = 'https://canonical-starter-pack.readthedocs-hosted.com/' | ||
| # The documentation website name (usually the same as the product name) | ||
| ogp_site_name = project | ||
| # An image or logo that is used in the preview | ||
| ogp_image = 'https://assets.ubuntu.com/v1/253da317-image-document-ubuntudocs.svg' | ||
|
|
||
| # Update with the favicon for your product (default is the circle of friends) | ||
| html_favicon = '.sphinx/_static/favicon.png' | ||
|
|
||
| # (Some settings must be part of the html_context dictionary, while others | ||
| # are on root level. Don't move the settings.) | ||
| html_context = { | ||
|
|
||
| # Change to the link to your product website (without "https://") | ||
| 'product_page': 'documentation.ubuntu.com', | ||
|
|
||
| # Add your product tag to ".sphinx/_static" and change the path | ||
| # here (start with "/static"), default is the circle of friends | ||
| 'product_tag': '/_static/tag.png', | ||
|
|
||
| # 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', | ||
|
|
||
| # Change to the GitHub info for your project | ||
| 'github_url': 'https://github.com/canonical/starter-pack', | ||
|
|
||
| # Change to the branch for this version of the documentation | ||
| 'github_version': 'main', | ||
|
|
||
| # Change to the folder that contains the documentation | ||
| # (usually "/" or "/docs/") | ||
| 'github_folder': '/', | ||
|
|
||
| # Change to an empty value if your GitHub repo doesn't have issues enabled. | ||
| # This will disable the feedback button and the issue link in the footer. | ||
| 'github_issues': 'enabled' | ||
| } | ||
|
|
||
| ############################################################ | ||
| ### Redirects | ||
| ############################################################ | ||
|
|
||
| # Set up redirects (https://documatt.gitlab.io/sphinx-reredirects/usage.html) | ||
| # For example: 'explanation/old-name.html': '../how-to/prettify.html', | ||
|
|
||
| redirects = {} | ||
|
|
||
| ############################################################ | ||
| ### Link checker exceptions | ||
| ############################################################ | ||
|
|
||
| # Links to ignore when checking links | ||
|
|
||
| linkcheck_ignore = [ | ||
| 'http://127.0.0.1:8000' | ||
| ] | ||
|
|
||
| ############################################################ | ||
| ### Additions to default configuration | ||
| ############################################################ | ||
|
|
||
| ## The following settings are appended to the default configuration. | ||
| ## Use them to extend the default functionality. | ||
|
|
||
| # Add extensions | ||
| custom_extensions = [] | ||
|
|
||
| # Add files or directories that should be excluded from processing. | ||
| custom_excludes = [] | ||
|
|
||
| # Add CSS files (located in .sphinx/_static/) | ||
| custom_html_css_files = [] | ||
|
|
||
| # Add JavaScript files (located in .sphinx/_static/) | ||
| custom_html_js_files = [] | ||
|
|
||
| ## The following settings override the default configuration. | ||
|
|
||
| # Specify a reST string that is included at the end of each file. | ||
| # If commented out, use the default (which pulls the reuse/links.txt | ||
| # file into each reST file). | ||
| # custom_rst_epilog = '' | ||
|
|
||
| # By default, the documentation includes a feedback button at the top. | ||
| # You can disable it by setting the following configuration to True. | ||
| disable_feedback_button = False | ||
|
|
||
| ############################################################ | ||
| ### Additional configuration | ||
| ############################################################ | ||
|
|
||
| ## Add any configuration that is not covered by the common conf.py file. |
Oops, something went wrong.