Page not found
6 |
7 |
16 |
8 |
15 |
9 | {{ body }}
10 |
11 |
12 |  }})
13 |
14 |
13 |
13 | Sorry, but the documentation page that you are looking for was not found.
\n\nDocumentation changes over time, and pages are moved around. We try to redirect you to the updated content where possible, but unfortunately, that didn\'t work this time (maybe because the content you were looking for does not exist in this version of the documentation).
\nYou can try to use the navigation to locate the content you\'re looking for, or search for a similar page.
\n', 86 | } 87 | 88 | # Default image for OGP (to prevent font errors, see 89 | # https://github.com/canonical/sphinx-docs-starter-pack/pull/54 ) 90 | if not 'ogp_image' in locals(): 91 | ogp_image = 'https://assets.ubuntu.com/v1/253da317-image-document-ubuntudocs.svg' 92 | 93 | ############################################################ 94 | ### General configuration 95 | ############################################################ 96 | 97 | exclude_patterns = [ 98 | '_build', 99 | 'Thumbs.db', 100 | '.DS_Store', 101 | '.sphinx', 102 | '.tox' 103 | ] 104 | exclude_patterns.extend(custom_excludes) 105 | 106 | rst_epilog = ''' 107 | .. include:: /reuse/links.txt 108 | ''' 109 | if 'custom_rst_epilog' in locals(): 110 | rst_epilog = custom_rst_epilog 111 | 112 | source_suffix = { 113 | '.rst': 'restructuredtext', 114 | '.md': 'markdown', 115 | } 116 | 117 | if not 'conf_py_path' in html_context and 'github_folder' in html_context: 118 | html_context['conf_py_path'] = html_context['github_folder'] 119 | 120 | # For ignoring specific links 121 | linkcheck_anchors_ignore_for_url = [ 122 | r'https://github\.com/.*' 123 | ] 124 | linkcheck_anchors_ignore_for_url.extend(custom_linkcheck_anchors_ignore_for_url) 125 | 126 | # Tags cannot be added directly in custom_conf.py, so add them here 127 | for tag in custom_tags: 128 | tags.add(tag) 129 | 130 | # html_context['get_contribs'] is a function and cannot be 131 | # cached (see https://github.com/sphinx-doc/sphinx/issues/12300) 132 | suppress_warnings = ["config.cache"] 133 | 134 | ############################################################ 135 | ### Styling 136 | ############################################################ 137 | 138 | # Find the current builder 139 | builder = 'dirhtml' 140 | if '-b' in sys.argv: 141 | builder = sys.argv[sys.argv.index('-b')+1] 142 | 143 | # Setting templates_path for epub makes the build fail 144 | if builder == 'dirhtml' or builder == 'html': 145 | templates_path = ['_templates'] 146 | notfound_template = '404.html' 147 | 148 | # Theme configuration 149 | html_theme = 'furo' 150 | html_last_updated_fmt = '' 151 | html_permalinks_icon = '¶' 152 | 153 | if html_title == '': 154 | html_theme_options = { 155 | 'sidebar_hide_name': True 156 | } 157 | 158 | ############################################################ 159 | ### Additional files 160 | ############################################################ 161 | 162 | html_static_path = ['_static'] 163 | 164 | html_css_files = [ 165 | 'custom.css', 166 | 'header.css', 167 | 'github_issue_links.css', 168 | 'furo_colors.css', 169 | 'footer.css', 170 | 'css/cookie-banner.css', 171 | ] 172 | html_css_files.extend(custom_html_css_files) 173 | 174 | html_js_files = ['header-nav.js', 'footer.js', 'js/bundle.js'] 175 | if 'github_issues' in html_context and html_context['github_issues'] and not disable_feedback_button: 176 | html_js_files.append('github_issue_links.js') 177 | html_js_files.extend(custom_html_js_files) 178 | 179 | ############################################################# 180 | # Display the contributors 181 | 182 | def get_contributors_for_file(github_url, github_folder, pagename, page_source_suffix, display_contributors_since=None): 183 | filename = f"{pagename}{page_source_suffix}" 184 | paths=html_context['github_folder'][1:] + filename 185 | 186 | try: 187 | repo = Repo(".") 188 | except InvalidGitRepositoryError: 189 | cwd = os.getcwd() 190 | ghfolder = html_context['github_folder'][:-1] 191 | if ghfolder and cwd.endswith(ghfolder): 192 | repo = Repo(cwd.rpartition(ghfolder)[0]) 193 | else: 194 | print("The local Git repository could not be found.") 195 | return 196 | 197 | since = display_contributors_since if display_contributors_since and display_contributors_since.strip() else None 198 | 199 | commits = repo.iter_commits(paths=paths, since=since) 200 | 201 | contributors_dict = {} 202 | for commit in commits: 203 | contributor = commit.author.name 204 | if contributor not in contributors_dict or commit.committed_date > contributors_dict[contributor]['date']: 205 | contributors_dict[contributor] = { 206 | 'date': commit.committed_date, 207 | 'sha': commit.hexsha 208 | } 209 | # The github_page contains the link to the contributor's latest commit. 210 | contributors_list = [{'name': name, 'github_page': f"{github_url}/commit/{data['sha']}"} for name, data in contributors_dict.items()] 211 | sorted_contributors_list = sorted(contributors_list, key=lambda x: x['name']) 212 | return sorted_contributors_list 213 | 214 | html_context['get_contribs'] = get_contributors_for_file 215 | ############################################################# 216 | -------------------------------------------------------------------------------- /custom_conf.py: -------------------------------------------------------------------------------- 1 | import datetime 2 | from requirements_parser import _get_requirements 3 | 4 | # Custom configuration for the Sphinx documentation builder. 5 | # All configuration specific to your project should be done in this file. 6 | # 7 | # The file is included in the common conf.py configuration file. 8 | # You can modify any of the settings below or add any configuration that 9 | # is not covered by the common conf.py file. 10 | # 11 | # For the full list of built-in configuration values, see the documentation: 12 | # https://www.sphinx-doc.org/en/master/usage/configuration.html 13 | # 14 | # If you're not familiar with Sphinx and don't want to use advanced 15 | # features, it is sufficient to update the settings in the "Project 16 | # information" section. 17 | 18 | ############################################################ 19 | ### Project information 20 | ############################################################ 21 | 22 | # Product name 23 | project = 'awspub' 24 | author = 'Canonical Ltd.' 25 | 26 | # The title you want to display for the documentation in the sidebar. 27 | # You might want to include a version number here. 28 | # To not display any title, set this option to an empty string. 29 | html_title = project + ' documentation' 30 | 31 | # The default value uses CC-BY-SA as the license and the current year 32 | # as the copyright year. 33 | # 34 | # If your documentation needs a different copyright license, use that 35 | # instead of 'CC-BY-SA'. Also, if your documentation is included as 36 | # part of the code repository of your project, it'll inherit the license 37 | # of the code. So you'll need to specify that license here (instead of 38 | # 'CC-BY-SA'). 39 | # 40 | # For static works, it is common to provide the year of first publication. 41 | # Another option is to give the first year and the current year 42 | # for documentation that is often changed, e.g. 2022–2023 (note the en-dash). 43 | # 44 | # A way to check a GitHub repo's creation date is to obtain a classic GitHub 45 | # token with 'repo' permissions here: https://github.com/settings/tokens 46 | # Next, use 'curl' and 'jq' to extract the date from the GitHub API's output: 47 | # 48 | # curl -H 'Authorization: token