From 2ad42c8d47d1a5e8c8bcb2be444a75bf363b6a04 Mon Sep 17 00:00:00 2001 From: Ivan Anfimov Date: Thu, 8 May 2025 11:36:42 +0000 Subject: [PATCH] docs: update openstackdocstheme to 3.5.0 and remove unicode from code In Python 3, all strings are represented in Unicode.In Python 2 are stored internally as 8-bit ASCII, hence it is required to attach 'u' to make it Unicode. It is no longer necessary now. And remove blank readme file. Change-Id: I35f1b7b42fa32daafa07af38378dba0402e5b8a5 --- doc/requirements.txt | 7 ++++--- doc/source/conf.py | 11 +++++------ doc/source/index.rst | 12 +++--------- doc/source/readme.rst | 1 - 4 files changed, 12 insertions(+), 19 deletions(-) delete mode 100644 doc/source/readme.rst diff --git a/doc/requirements.txt b/doc/requirements.txt index e36a73f..2cad5df 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,3 +1,4 @@ -openstackdocstheme>=2.2.0 # Apache-2.0 -sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD -reno>=3.1.0 # Apache-2.0 +sphinxcontrib-svg2pdfconverter>=1.2.3 # BSD +openstackdocstheme>=3.5.0 # Apache-2.0 +doc8>=1.1.2 # Apache-2.0 +reno>=4.1.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 879dcb0..d3f7ef8 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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 @@ -45,8 +44,8 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'designate_dashboard' -copyright = u'2013, OpenStack Foundation' +project = 'designate_dashboard' +copyright = '2013, OpenStack Foundation' # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -75,8 +74,8 @@ htmlhelp_basename = '%sdoc' % project latex_documents = [ ('index', 'doc-designate-dashboard.tex', - u'Designate Dashboard Documentation', - u'OpenStack Foundation', 'manual', True), + 'Designate Dashboard Documentation', + 'OpenStack Foundation', 'manual', True), ] latex_domain_indices = False @@ -91,4 +90,4 @@ latex_elements = { } # Example configuration for intersphinx: refer to the Python standard library. -#intersphinx_mapping = {'http://docs.python.org/': None} +#intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/doc/source/index.rst b/doc/source/index.rst index 2bced7e..11d3a8a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,16 +1,10 @@ -.. designate_ui documentation master file, created by - sphinx-quickstart on Tue Jul 9 22:26:36 2013. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -================================================ - Welcome to designatedashboard's documentation! -================================================ +============================================= + Welcome to Designate Dashboard Documentation +============================================= .. toctree:: :maxdepth: 2 - readme install/index user/index contributor/index diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index 38ba804..0000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst \ No newline at end of file