mirror of
https://github.com/nextcloud/documentation.git
synced 2025-12-12 07:29:47 +07:00
627b4a4fd3
Disable inclusion of RST sources in HTML builds. This would normally be used if we we had the links for readers to view the RST source code. We don't and there's no point in doing so. - Already the case for the User Manual, but not the others; this makes it global across all manuals - No need to include RST source since we're not linking to it (i.e. we're not using `html_show_sourcelink` anywhere). Signed-off-by: Josh <josh.t.richards@gmail.com>
119 lines
3.4 KiB
Python
119 lines
3.4 KiB
Python
# global configuration for every documentation added at the end
|
|
|
|
import os, sys, datetime
|
|
|
|
import sphinx_rtd_theme
|
|
|
|
dir_path = os.path.dirname(os.path.realpath(__file__))
|
|
sys.path.insert(0, os.path.abspath(dir_path + '/_ext'))
|
|
now = datetime.datetime.now()
|
|
|
|
os.environ["READTHEDOCS"] = "True"
|
|
|
|
extensions = [
|
|
'sphinx_rtd_theme',
|
|
'sphinx_rtd_dark_mode',
|
|
'sphinx_copybutton',
|
|
'sphinxcontrib.mermaid',
|
|
'notfound.extension',
|
|
]
|
|
|
|
# General information about the project.
|
|
copyright = '2016-' + str(now.year) + ' Nextcloud GmbH and Nextcloud contributors'
|
|
|
|
# The version info for the project you're documenting, acts as replacement for
|
|
# |version| and |release|, also used in various other places throughout the
|
|
# built documents.
|
|
#
|
|
# The short X.Y version.
|
|
version = 'latest'
|
|
# The full version, including alpha/beta/rc tags.
|
|
release = version
|
|
|
|
# RTD theme options
|
|
html_theme_options = {
|
|
'logo_only': True,
|
|
'navigation_with_keys': True,
|
|
'style_external_links': True,
|
|
'version_selector': False,
|
|
}
|
|
|
|
# relative path to subdirectories
|
|
html_logo = "../_shared_assets/static/logo-white.png"
|
|
|
|
# disable including the reST sources in HTML builds (in _sources/) (default is True)
|
|
html_copy_source = False
|
|
|
|
# substitutions go here
|
|
rst_epilog = '.. |version| replace:: %s' % version
|
|
|
|
# building the versions list
|
|
version_start = 29 # THIS IS THE OLDEST SUPPORTED VERSION NUMBER
|
|
|
|
# THIS IS THE VERSION THAT IS MAPPED TO https://docs.nextcloud.com/server/stable/
|
|
version_stable = 31 # CHANGING IT MUST RESULT IN A CHANGE OF THE SYMLINK ON THE LIVE SERVER
|
|
|
|
# Also search for "TODO ON RELEASE" in the rst files
|
|
|
|
def generateVersionsDocs(current_docs):
|
|
versions_doc = []
|
|
for v in range(version_start, version_stable + 1):
|
|
url = 'https://docs.nextcloud.com/server/%s/%s' % (str(v), current_docs)
|
|
versions_doc.append(tuple((v, url)))
|
|
versions_doc.append(tuple(('stable', 'https://docs.nextcloud.com/server/%s/%s' % ('stable', current_docs))))
|
|
versions_doc.append(tuple(('latest', 'https://docs.nextcloud.com/server/%s/%s' % ('latest', current_docs))))
|
|
return versions_doc
|
|
|
|
if version.isdigit():
|
|
github_branch = 'stable%s' % version
|
|
else:
|
|
github_branch = 'master'
|
|
|
|
html_context = {
|
|
'current_version': version,
|
|
'READTHEDOCS': True,
|
|
|
|
# force github plugin
|
|
'display_github': True,
|
|
'github_user': 'nextcloud',
|
|
'github_repo': 'documentation',
|
|
# If current version is an int, use the stablexxx branches, otherwise, edit on master
|
|
'theme_vcs_pageview_mode': 'edit/%s/' % github_branch, # to be completed by each individual conf.py
|
|
}
|
|
|
|
html_static_path = ['_static']
|
|
# Extra CSS relative to html_static_path
|
|
html_css_files = [
|
|
'custom.css'
|
|
]
|
|
|
|
edit_on_github_project = 'nextcloud/documentation'
|
|
edit_on_github_branch = 'master'
|
|
|
|
# user starts in light mode
|
|
default_dark_mode = False
|
|
|
|
latex_engine = "xelatex"
|
|
|
|
# -- Options for sphinx-notfound-page extension -----------------------------------
|
|
# https://github.com/readthedocs/sphinx-notfound-page
|
|
|
|
# content context passed to the 404 template
|
|
notfound_context = {
|
|
"title": "404 Page Not Found",
|
|
"body": """
|
|
<h1>Page Not Found</h1>
|
|
<h2>Sorry, we can't seem to find the page you're looking for.</h2>
|
|
<h6>Error code: 404</h6>
|
|
|
|
<h3>Here are some alternatives:</h3>
|
|
<ol>
|
|
<li>Try using the search box.</li>
|
|
<li>Check the content menu on the side of this page.</li>
|
|
<li>Regroup at our <a href="/">documentation homepage.</a></p></li>
|
|
</ol>
|
|
""",
|
|
}
|
|
|
|
notfound_urls_prefix = None
|