Apple-2-SW/prog8
1
0
Fork 0
mirror of https://github.com/irmen/prog8.git synced 2025-02-09 23:30:45 +00:00
Code Issues Projects Releases Wiki Activity

attempt at doc fix

Browse Source
This commit is contained in:
Irmen de Jong 2023-03-17 22:12:47 +01:00
parent de84547a21
commit 7c5b7f77cc
1 changed files with 137 additions and 138 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

275
docs/source/conf.py
View File

@ -12,7 +12,6 @@
# add these directories to sys.path here. If the directory is relative to the # 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. # documentation root, use os.path.abspath to make it absolute, like shown here.
# #
import os
# import sys # import sys
# sys.path.insert(0, os.path.abspath('.')) # sys.path.insert(0, os.path.abspath('.'))
@ -29,147 +28,147 @@ version = open("../../compiler/res/version.txt").readline()
# The full version, including alpha/beta/rc tags # The full version, including alpha/beta/rc tags
release = version release = version
# -- extensions # # -- extensions
def setup(app):
# add custom css
app.add_css_file("css/customize.css")
# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
# #
needs_sphinx = '4.0' # def setup(app):
# # add custom css
# Add any Sphinx extension module names here, as strings. They can be # app.add_css_file("css/customize.css")
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.todo',
'sphinx.ext.githubpages',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
# #
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# #
# This is also used if you do content translation via gettext catalogs. # # -- General configuration ---------------------------------------------------
# Usually you set "language" from the command line for these cases.
language = 'en'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path .
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
highlight_language = 'none'
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
# #
html_theme = 'sphinx_rtd_theme' # # If your documentation needs a minimal Sphinx version, state it here.
# #
# logo in top of sidebar # needs_sphinx = '6.0'
html_logo = '_static/logo_small.jpg'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
# #
# html_theme_options = {} # # Add any Sphinx extension module names here, as strings. They can be
# # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# Add any paths that contain custom static files (such as style sheets) here, # # ones.
# relative to this directory. They are copied after the builtin static files, # extensions = [
# so a file named "default.css" will overwrite the builtin "default.css". # 'sphinx.ext.todo',
html_static_path = ['_static'] # 'sphinx.ext.githubpages',
# ]
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
# #
# The default sidebars (for documents that don't match any pattern) are # # Add any paths that contain templates here, relative to this directory.
# defined by theme itself. Builtin themes are using these templates by # templates_path = ['_templates']
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
# #
# html_sidebars = {} # # The suffix(es) of source filenames.
# # You can specify multiple suffix as a list of string:
# #
# -- Options for HTMLHelp output --------------------------------------------- # # source_suffix = ['.rst', '.md']
# source_suffix = '.rst'
# Output file base name for HTML help builder. #
htmlhelp_basename = 'Prog8doc' # # The master toctree document.
# master_doc = 'index'
#
# -- Options for LaTeX output ------------------------------------------------ # # The language for content autogenerated by Sphinx. Refer to documentation
# # for a list of supported languages.
latex_elements = { # #
# The paper size ('letterpaper' or 'a4paper'). # # This is also used if you do content translation via gettext catalogs.
# # # Usually you set "language" from the command line for these cases.
# 'papersize': 'letterpaper', # language = 'en'
#
# The font size ('10pt', '11pt' or '12pt'). # # List of patterns, relative to source directory, that match files and
# # # directories to ignore when looking for source files.
# 'pointsize': '10pt', # # This pattern also affects html_static_path and html_extra_path .
# exclude_patterns = []
# Additional stuff for the LaTeX preamble. #
# # # The name of the Pygments (syntax highlighting) style to use.
# 'preamble': '', # pygments_style = 'sphinx'
# highlight_language = 'none'
# Latex figure (float) alignment #
# #
# 'figure_align': 'htbp', # # -- Options for HTML output -------------------------------------------------
} #
# # The theme to use for HTML and HTML Help pages. See the documentation for
# Grouping the document tree into LaTeX files. List of tuples # # a list of builtin themes.
# (source start file, target name, title, # #
# author, documentclass [howto, manual, or own class]). # html_theme = 'sphinx_rtd_theme'
latex_documents = [ #
(master_doc, 'Prog8.tex', 'Prog8 Documentation', # # logo in top of sidebar
'Irmen de Jong', 'manual'), # html_logo = '_static/logo_small.jpg'
] #
# # Theme options are theme-specific and customize the look and feel of a theme
# # further. For a list of options available for each theme, see the
# -- Options for manual page output ------------------------------------------ # # documentation.
# #
# One entry per manual page. List of tuples # # html_theme_options = {}
# (source start file, name, description, authors, manual section). #
man_pages = [ # # Add any paths that contain custom static files (such as style sheets) here,
(master_doc, 'prog8', 'Prog8 Documentation', # # relative to this directory. They are copied after the builtin static files,
[author], 1) # # so a file named "default.css" will overwrite the builtin "default.css".
] # html_static_path = ['_static']
#
# # Custom sidebar templates, must be a dictionary that maps document names
# -- Options for Texinfo output ---------------------------------------------- # # to template names.
# #
# Grouping the document tree into Texinfo files. List of tuples # # The default sidebars (for documents that don't match any pattern) are
# (source start file, target name, title, author, # # defined by theme itself. Builtin themes are using these templates by
# dir menu entry, description, category) # # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
texinfo_documents = [ # # 'searchbox.html']``.
(master_doc, 'Prog8', 'Prog8 Documentation', # #
author, 'Prog8', 'One line description of project.', # # html_sidebars = {}
'Miscellaneous'), #
] #
# # -- Options for HTMLHelp output ---------------------------------------------
#
# -- Extension configuration ------------------------------------------------- # # Output file base name for HTML help builder.
# htmlhelp_basename = 'Prog8doc'
# -- Options for to do extension ---------------------------------------------- #
#
todo_include_todos = True # # -- Options for LaTeX output ------------------------------------------------
#
# latex_elements = {
# # The paper size ('letterpaper' or 'a4paper').
# #
# # 'papersize': 'letterpaper',
#
# # The font size ('10pt', '11pt' or '12pt').
# #
# # 'pointsize': '10pt',
#
# # Additional stuff for the LaTeX preamble.
# #
# # 'preamble': '',
#
# # Latex figure (float) alignment
# #
# # 'figure_align': 'htbp',
# }
#
# # Grouping the document tree into LaTeX files. List of tuples
# # (source start file, target name, title,
# # author, documentclass [howto, manual, or own class]).
# latex_documents = [
# (master_doc, 'Prog8.tex', 'Prog8 Documentation',
# 'Irmen de Jong', 'manual'),
# ]
#
#
# # -- Options for manual page output ------------------------------------------
#
# # One entry per manual page. List of tuples
# # (source start file, name, description, authors, manual section).
# man_pages = [
# (master_doc, 'prog8', 'Prog8 Documentation',
# [author], 1)
# ]
#
#
# # -- 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 = [
# (master_doc, 'Prog8', 'Prog8 Documentation',
# author, 'Prog8', 'One line description of project.',
# 'Miscellaneous'),
# ]
#
#
# # -- Extension configuration -------------------------------------------------
#
# # -- Options for to do extension ----------------------------------------------
#
# todo_include_todos = True