Merge "remove unicode from files and update configuration for documentation"

2025-11-26 21:36:30 +00:00
parent 4c62b609f5 8bf595775a
commit bd846dfc6f
4 changed files with 35 additions and 30 deletions
@@ -22,6 +22,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.

+from datetime import datetime
+
 import logging
 import os
 import sys
@@ -34,7 +36,6 @@ import django
 logging.getLogger('openstack_dashboard.settings').setLevel(logging.ERROR)
 logging.getLogger('horizon.test.helpers').setLevel(logging.ERROR)

-
 BASE_DIR = os.path.dirname(os.path.abspath(__file__))
 ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", ".."))

@@ -46,7 +47,6 @@ os.environ.setdefault('DJANGO_SETTINGS_MODULE',

 django.setup()

-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -106,7 +106,13 @@ source_suffix = '.rst'
 master_doc = 'index'

 # General information about the project.
-copyright = '2012, OpenStack Foundation'
+project = 'OpenStack Horizon'
+author = 'OpenStack Horizon Contributors'
+category = 'Miscellaneous'
+copyright = f'2012-{datetime.now().year}, OpenStack Horizon Contributors'
+description = 'Dashboard for OpenStack.'
+title = 'OpenStack Horizon Documentation'
+target_name = 'openstack-horizon'

 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -146,7 +152,6 @@ modindex_common_prefix = ['horizon.', 'openstack_dashboard.']
 primary_domain = 'py'
 nitpicky = False

-
 # -- Options for HTML output --------------------------------------------------

 # The theme to use for HTML and HTML Help pages.  See the documentation for
@@ -227,7 +232,7 @@ html_static_path = []
 # html_file_suffix = None

 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Horizondoc'
+htmlhelp_basename = target_name + '-docs'

 # -- Options for LaTeX output -------------------------------------------------

@@ -235,8 +240,8 @@ htmlhelp_basename = 'Horizondoc'
 # (source start file, target name, title, author, documentclass
 # [howto/manual]).
 latex_documents = [
-    ('index', 'doc-horizon.tex', 'Horizon Documentation',
-     'OpenStack Foundation', 'manual'),
+    (master_doc, 'doc-' + target_name + '.tex',
+     title, author, 'manual'),
 ]

 # The name of an image file (relative to this directory) to place at the top of
@@ -273,8 +278,8 @@ latex_use_xindy = False
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'horizon', 'Horizon Documentation',
-     ['OpenStack'], 1)
+    (master_doc, target_name,
+     title, [author], 1)
 ]

 # If true, show URL addresses after external links.
@@ -287,8 +292,9 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'Horizon', 'Horizon Documentation', 'OpenStack',
-     'Horizon', 'One line description of project.', 'Miscellaneous'),
+    (master_doc, target_name,
+     title, author, openstackdocs_bug_project,
+     description, category),
 ]

 # Documents to append as an appendix to all manuals.
@@ -300,7 +306,6 @@ texinfo_documents = [
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
 # texinfo_show_urls = 'footnote'

-
 # -- Options for Epub output --------------------------------------------------

 # Bibliographic Dublin Core info.
@@ -343,4 +348,5 @@ epub_copyright = '2012, OpenStack'
 # Allow duplicate toc entries.
 # epub_tocdup = True

+# -- Options for Internationalization output ------------------------------
 locale_dirs = ['locale/']
@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # ----------------------------------------------------------------------
 # NOTE: The default values of the settings are defined in
 # openstack_dashboard/defaults.py. Previously most available settings
@@ -1,5 +1,3 @@
-# coding: utf-8
-
 # Copyright 2016 Cisco Systems, Inc.
 # Copyright 2015 IBM Corp.
 #
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -29,6 +28,8 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 # sys.path.insert(0, os.path.abspath('.'))

+from datetime import datetime
+
 # -- General configuration ------------------------------------------------

 # If your documentation needs a minimal Sphinx version, state it here.
@@ -75,7 +76,13 @@ source_suffix = '.rst'
 master_doc = 'index'

 # General information about the project.
-copyright = '2015, Horizon Developers'
+project = 'OpenStack Horizon'
+author = 'OpenStack Horizon Contributors'
+category = 'Miscellaneous'
+copyright = f'2015-{datetime.now().year}, OpenStack Horizon Contributors'
+description = 'Dashboard for OpenStack.'
+title = 'OpenStack Horizon Release Notes'
+target_name = 'openstack-horizon'

 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -194,8 +201,7 @@ html_static_path = ['_static']
 # html_file_suffix = None

 # Output file base name for HTML help builder.
-htmlhelp_basename = 'HorizonReleaseNotesdoc'
-
+htmlhelp_basename = target_name + '-docs'

 # -- Options for LaTeX output ---------------------------------------------

@@ -203,9 +209,8 @@ htmlhelp_basename = 'HorizonReleaseNotesdoc'
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    ('index', 'HorizonReleaseNotes.tex',
-     'Horizon Release Notes Documentation',
-     'Horizon Developers', 'manual'),
+    (master_doc, target_name + '.tex',
+     title, author, 'manual'),
 ]

 # The name of an image file (relative to this directory) to place at the top of
@@ -234,24 +239,22 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'horizonreleasenotes', 'Horizon Release Notes Documentation',
-     ['Horizon Developers'], 1)
+    (master_doc, target_name,
+     title, [author], 1)
 ]

 # If true, show URL addresses after external links.
 # man_show_urls = False

-
 # -- Options for Texinfo output -------------------------------------------

 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'HorizonReleaseNotes', 'Horizon Release Notes Documentation',
-     'Horizon Developers', 'HorizonReleaseNotes',
-     'Dashboard for OpenStack.',
-     'Miscellaneous'),
+    (master_doc, target_name,
+     title, author, project,
+     description, category),
 ]

 # Documents to append as an appendix to all manuals.