Merge pull request #62 from LibreSign/feat/implement-sphinx-notfound-page

feat: implement sphinx-notfound-page

Author: vitormattos

admin_manual/conf.py

@@ -1,30 +1,5 @@
 import os
 import sys
 import datetime
-sys.path.insert(0, os.path.abspath('.'))
-
-now = datetime.datetime.now()
-
-copyright = str(now.year) + ' LibreCode coop'
-project = 'LibreSign Documentation'
-author = 'LibreSign Team'
-release = '1.0'
-
-extensions = [
-    'sphinx_rtd_theme',
-    'sphinx_rtd_dark_mode',
-    'sphinx_copybutton',
-]
-
-templates_path = ['_templates']
-exclude_patterns = []
-
-html_theme = 'sphinx_rtd_theme'
-html_logo = "images/logo.png"
-html_theme_options = {
-    'style_nav_header_background': '#184c4e',
-	'logo_only': True,
-	'navigation_with_keys': True,
-	'style_external_links': True,
-	'version_selector': False,
-}
+sys.path.insert(0, os.path.abspath('../'))
+from conf import *

conf.py

@@ -0,0 +1,54 @@
+import os
+import sys
+import datetime
+sys.path.insert(0, os.path.abspath('.'))
+
+now = datetime.datetime.now()
+
+copyright = str(now.year) + ' LibreCode coop'
+project = 'LibreSign Documentation'
+author = 'LibreSign Team'
+release = '1.0'
+
+extensions = [
+    'sphinx_rtd_theme',
+    'sphinx_rtd_dark_mode',
+    'sphinx_copybutton',
+    'notfound.extension',
+]
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+html_theme = 'sphinx_rtd_theme'
+html_logo = "images/logo.png"
+html_theme_options = {
+    'style_nav_header_background': '#184c4e',
+	'logo_only': True,
+	'navigation_with_keys': True,
+	'style_external_links': True,
+	'version_selector': False,
+}
+html_extra_path = ['html']
+
+# -- 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

developer_manual/conf.py

@@ -1,31 +1,5 @@
 import os
 import sys
 import datetime
-sys.path.insert(0, os.path.abspath('.'))
-
-now = datetime.datetime.now()
-
-copyright = str(now.year) + ' LibreCode coop'
-project = 'LibreSign Documentation'
-author = 'LibreSign Team'
-release = '1.0'
-
-extensions = [
-    'sphinx_rtd_theme',
-    'sphinx_rtd_dark_mode',
-    'sphinx_copybutton',
-]
-
-templates_path = ['_templates']
-exclude_patterns = []
-
-html_theme = 'sphinx_rtd_theme'
-html_logo = "images/logo.png"
-html_theme_options = {
-    'style_nav_header_background': '#184c4e',
-	'logo_only': True,
-	'navigation_with_keys': True,
-	'style_external_links': True,
-	'version_selector': False,
-}
-html_extra_path = ['html']
+sys.path.insert(0, os.path.abspath('../'))
+from conf import *

requirements.txt

@@ -5,4 +5,5 @@ sphinxcontrib-openapi==0.8.4
 sphinxcontrib-redoc
 sphinx-autobuild
 sphinx-copybutton
+sphinx-notfound-page
 docutils==0.21.2

user_manual/conf.py

@@ -1,30 +1,5 @@
 import os
 import sys
 import datetime
-sys.path.insert(0, os.path.abspath('.'))
-
-now = datetime.datetime.now()
-
-copyright = str(now.year) + ' LibreCode coop'
-project = 'LibreSign Documentation'
-author = 'LibreSign Team'
-release = '1.0'
-
-extensions = [
-    'sphinx_rtd_theme',
-    'sphinx_rtd_dark_mode',
-    'sphinx_copybutton',
-]
-
-templates_path = ['_templates']
-exclude_patterns = []
-
-html_theme = 'sphinx_rtd_theme'
-html_logo = "images/logo.png"
-html_theme_options = {
-    'style_nav_header_background': '#184c4e',
-	'logo_only': True,
-	'navigation_with_keys': True,
-	'style_external_links': True,
-	'version_selector': False,
-}
+sys.path.insert(0, os.path.abspath('../'))
+from conf import *