docs(sphinx): fix conf.py and index.rst to resolve warnings
Some checks failed
CI / Check spelling (pull_request) Successful in 51s
CI / Test C API Documentation Generation (pull_request) Successful in 52s
CI / Check coding style (pull_request) Successful in 1m22s
CI / Test Python API Documentation Generation (pull_request) Failing after 1m1s
CI / Linux (debian) (pull_request) Successful in 12m49s
CI / Linux (ubuntu) (pull_request) Successful in 13m12s
CI / Linux (arch) (pull_request) Successful in 16m22s
Some checks failed
CI / Check spelling (pull_request) Successful in 51s
CI / Test C API Documentation Generation (pull_request) Successful in 52s
CI / Check coding style (pull_request) Successful in 1m22s
CI / Test Python API Documentation Generation (pull_request) Failing after 1m1s
CI / Linux (debian) (pull_request) Successful in 12m49s
CI / Linux (ubuntu) (pull_request) Successful in 13m12s
CI / Linux (arch) (pull_request) Successful in 16m22s
- Removed unnecessary list item (*) from :ref:`genindex`. - Added blank line after :ref:`genindex` to terminate markup block. - Rebranded configs
This commit is contained in:
@@ -1,7 +1,6 @@
|
|||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
#
|
#
|
||||||
# Profanity Python Plugins API documentation build configuration file, created by
|
# CProof Python Plugins API documentation build configuration file.
|
||||||
# sphinx-quickstart on Thu Mar 17 23:01:31 2016.
|
|
||||||
#
|
#
|
||||||
# This file is execfile()d with the current directory set to its
|
# This file is execfile()d with the current directory set to its
|
||||||
# containing dir.
|
# containing dir.
|
||||||
@@ -47,25 +46,25 @@ source_suffix = '.rst'
|
|||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
project = u'Profanity Python Plugins API'
|
project = u'CProof Python Plugins API'
|
||||||
copyright = u'2016 - 2018, boothj5'
|
copyright = u'2025, CProof, based on Profanity by boothj5 et al.'
|
||||||
author = u'boothj5'
|
author = u'CProof Developers'
|
||||||
|
|
||||||
# The version info for the project you're documenting, acts as replacement for
|
# The version info for the project you're documenting, acts as replacement for
|
||||||
# |version| and |release|, also used in various other places throughout the
|
# |version| and |release|, also used in various other places throughout the
|
||||||
# built documents.
|
# built documents.
|
||||||
#
|
#
|
||||||
# The short X.Y version.
|
# The short X.Y version.
|
||||||
version = u'0.5.0'
|
version = u'0.15.0'
|
||||||
# The full version, including alpha/beta/rc tags.
|
# The full version, including alpha/beta/rc tags.
|
||||||
release = u'0.5.0'
|
release = u'0.15.0'
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
# for a list of supported languages.
|
# for a list of supported languages.
|
||||||
#
|
#
|
||||||
# This is also used if you do content translation via gettext catalogs.
|
# This is also used if you do content translation via gettext catalogs.
|
||||||
# Usually you set "language" from the command line for these cases.
|
# Usually you set "language" from the command line for these cases.
|
||||||
language = None
|
language = 'en'
|
||||||
|
|
||||||
# There are two options for replacing |today|: either, you set today to some
|
# There are two options for replacing |today|: either, you set today to some
|
||||||
# non-false value, then it is used:
|
# non-false value, then it is used:
|
||||||
@@ -122,7 +121,7 @@ html_theme = 'default'
|
|||||||
|
|
||||||
# The name for this set of Sphinx documents. If None, it defaults to
|
# The name for this set of Sphinx documents. If None, it defaults to
|
||||||
# "<project> v<release> documentation".
|
# "<project> v<release> documentation".
|
||||||
html_title = "Profanity Python Plugins"
|
html_title = "CProof Python Plugins"
|
||||||
|
|
||||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||||
#html_short_title = None
|
#html_short_title = None
|
||||||
@@ -139,7 +138,7 @@ html_title = "Profanity Python Plugins"
|
|||||||
# Add any paths that contain custom static files (such as style sheets) here,
|
# Add any paths that contain custom static files (such as style sheets) here,
|
||||||
# relative to this directory. They are copied after the builtin static files,
|
# relative to this directory. They are copied after the builtin static files,
|
||||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||||
html_static_path = ['_static']
|
# html_static_path = ['_static']
|
||||||
|
|
||||||
# Add any extra paths that contain custom files (such as robots.txt or
|
# Add any extra paths that contain custom files (such as robots.txt or
|
||||||
# .htaccess) here, relative to this directory. These files are copied
|
# .htaccess) here, relative to this directory. These files are copied
|
||||||
@@ -202,7 +201,7 @@ html_show_copyright = False
|
|||||||
#html_search_scorer = 'scorer.js'
|
#html_search_scorer = 'scorer.js'
|
||||||
|
|
||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = 'ProfanityPythonPluginsAPIdoc'
|
htmlhelp_basename = 'CProofPythonPluginsAPIdoc'
|
||||||
|
|
||||||
# -- Options for LaTeX output ---------------------------------------------
|
# -- Options for LaTeX output ---------------------------------------------
|
||||||
|
|
||||||
@@ -224,8 +223,8 @@ latex_elements = {
|
|||||||
# (source start file, target name, title,
|
# (source start file, target name, title,
|
||||||
# author, documentclass [howto, manual, or own class]).
|
# author, documentclass [howto, manual, or own class]).
|
||||||
latex_documents = [
|
latex_documents = [
|
||||||
(master_doc, 'ProfanityPythonPluginsAPI.tex', u'Profanity Python Plugins API Documentation',
|
(master_doc, 'CProofPythonPluginsAPI.tex', u'CProof Python Plugins API Documentation',
|
||||||
u'boothj5', 'manual'),
|
u'CProof Developers', 'manual'),
|
||||||
]
|
]
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top of
|
# The name of an image file (relative to this directory) to place at the top of
|
||||||
@@ -254,7 +253,7 @@ latex_documents = [
|
|||||||
# One entry per manual page. List of tuples
|
# One entry per manual page. List of tuples
|
||||||
# (source start file, name, description, authors, manual section).
|
# (source start file, name, description, authors, manual section).
|
||||||
man_pages = [
|
man_pages = [
|
||||||
(master_doc, 'profanitypythonpluginsapi', u'Profanity Python Plugins API Documentation',
|
(master_doc, 'cproofpythonpluginsapi', u'CProof Python Plugins API Documentation',
|
||||||
[author], 1)
|
[author], 1)
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
Profanity Python Plugins API
|
CProof Python Plugins API
|
||||||
============================
|
========================
|
||||||
|
|
||||||
The ``prof`` module describes functions that plugins may call to interact with Profanity.
|
The ``prof`` module describes functions that plugins may call to interact with CProof.
|
||||||
The ``plugin`` module describes functions that plugins may define to be notified of various events in Profanity.
|
The ``plugin`` module describes functions that plugins may define to be notified of various events in CProof.
|
||||||
|
|
||||||
Contents:
|
Contents:
|
||||||
|
|
||||||
@@ -11,4 +11,5 @@ Contents:
|
|||||||
|
|
||||||
prof
|
prof
|
||||||
plugin
|
plugin
|
||||||
* :ref:`genindex`
|
|
||||||
|
:ref:`genindex`
|
||||||
|
|||||||
Reference in New Issue
Block a user