Skip to content

Commit df2a804

Browse files
author
Louis Nicolas Stenger
committed
Update Sphinx
1 parent 0d2401c commit df2a804

File tree

4 files changed

+63
-268
lines changed

4 files changed

+63
-268
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/_build

conf.py

Lines changed: 27 additions & 215 deletions
Original file line numberDiff line numberDiff line change
@@ -1,242 +1,54 @@
1-
# -*- coding: utf-8 -*-
1+
# Configuration file for the Sphinx documentation builder.
22
#
3-
# Fortran90 documentation build configuration file, created by
4-
# sphinx-quickstart on Fri Jan 20 23:59:21 2012.
5-
#
6-
# This file is execfile()d with the current directory set to its containing dir.
7-
#
8-
# Note that not all possible configuration values are present in this
9-
# autogenerated file.
10-
#
11-
# All configuration values have a default; values that are commented out
12-
# serve to show the default.
3+
# This file only contains a selection of the most common options. For a full
4+
# list see the documentation:
5+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
136

14-
import sys, os
7+
# -- Path setup --------------------------------------------------------------
158

169
# If extensions (or modules to document with autodoc) are in another directory,
1710
# add these directories to sys.path here. If the directory is relative to the
1811
# documentation root, use os.path.abspath to make it absolute, like shown here.
19-
#sys.path.insert(0, os.path.abspath('.'))
20-
sys.path.append(os.path.abspath('exts'))
21-
22-
# -- General configuration -----------------------------------------------------
23-
24-
# If your documentation needs a minimal Sphinx version, state it here.
25-
#needs_sphinx = '1.0'
26-
27-
# Add any Sphinx extension module names here, as strings. They can be extensions
28-
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
29-
extensions = ['sphinx.ext.pngmath', "math_dollar"]
12+
#
13+
import os
14+
import sys
15+
# sys.path.insert(0, os.path.abspath('.'))
3016

31-
# Add any paths that contain templates here, relative to this directory.
32-
templates_path = ['_templates']
3317

34-
# The suffix of source filenames.
35-
source_suffix = '.rst'
18+
# -- Project information -----------------------------------------------------
3619

37-
# The encoding of source files.
38-
#source_encoding = 'utf-8-sig'
20+
project = 'Fortran90'
21+
copyright = '2024, Ondřej Čertík'
3922

40-
# The master toctree document.
41-
master_doc = 'index'
23+
# The full version, including alpha/beta/rc tags
24+
release = '1.0'
4225

43-
# General information about the project.
44-
project = u'Fortran90'
45-
copyright = u'2012, Ondřej Čertík'
4626

47-
# The version info for the project you're documenting, acts as replacement for
48-
# |version| and |release|, also used in various other places throughout the
49-
# built documents.
50-
#
51-
# The short X.Y version.
52-
version = '1.0'
53-
# The full version, including alpha/beta/rc tags.
54-
release = '1.0'
27+
# -- General configuration ---------------------------------------------------
5528

56-
# The language for content autogenerated by Sphinx. Refer to documentation
57-
# for a list of supported languages.
58-
#language = None
29+
# Add any Sphinx extension module names here, as strings. They can be
30+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
31+
# ones.
32+
extensions = [
33+
]
5934

60-
# There are two options for replacing |today|: either, you set today to some
61-
# non-false value, then it is used:
62-
#today = ''
63-
# Else, today_fmt is used as the format for a strftime call.
64-
#today_fmt = '%B %d, %Y'
35+
# Add any paths that contain templates here, relative to this directory.
36+
templates_path = ['_templates']
6537

6638
# List of patterns, relative to source directory, that match files and
6739
# directories to ignore when looking for source files.
68-
exclude_patterns = ['_build']
69-
70-
# The reST default role (used for this markup: `text`) to use for all documents.
71-
#default_role = None
72-
73-
# If true, '()' will be appended to :func: etc. cross-reference text.
74-
#add_function_parentheses = True
40+
# This pattern also affects html_static_path and html_extra_path.
41+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "README.rst"]
7542

76-
# If true, the current module name will be prepended to all description
77-
# unit titles (such as .. function::).
78-
#add_module_names = True
7943

80-
# If true, sectionauthor and moduleauthor directives will be shown in the
81-
# output. They are ignored by default.
82-
#show_authors = False
83-
84-
# The name of the Pygments (syntax highlighting) style to use.
85-
pygments_style = 'sphinx'
86-
87-
# A list of ignored prefixes for module index sorting.
88-
#modindex_common_prefix = []
89-
90-
91-
# -- Options for HTML output ---------------------------------------------------
44+
# -- Options for HTML output -------------------------------------------------
9245

9346
# The theme to use for HTML and HTML Help pages. See the documentation for
9447
# a list of builtin themes.
95-
html_theme = 'default'
96-
97-
# Theme options are theme-specific and customize the look and feel of a theme
98-
# further. For a list of options available for each theme, see the
99-
# documentation.
100-
#html_theme_options = {}
101-
102-
# Add any paths that contain custom themes here, relative to this directory.
103-
#html_theme_path = []
104-
105-
# The name for this set of Sphinx documents. If None, it defaults to
106-
# "<project> v<release> documentation".
107-
#html_title = None
108-
109-
# A shorter title for the navigation bar. Default is the same as html_title.
110-
#html_short_title = None
111-
112-
# The name of an image file (relative to this directory) to place at the top
113-
# of the sidebar.
114-
#html_logo = None
115-
116-
# The name of an image file (within the static path) to use as favicon of the
117-
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
118-
# pixels large.
119-
#html_favicon = None
48+
#
49+
html_theme = 'classic'
12050

12151
# Add any paths that contain custom static files (such as style sheets) here,
12252
# relative to this directory. They are copied after the builtin static files,
12353
# so a file named "default.css" will overwrite the builtin "default.css".
12454
html_static_path = ['_static']
125-
126-
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
127-
# using the given strftime format.
128-
#html_last_updated_fmt = '%b %d, %Y'
129-
130-
# If true, SmartyPants will be used to convert quotes and dashes to
131-
# typographically correct entities.
132-
#html_use_smartypants = True
133-
134-
# Custom sidebar templates, maps document names to template names.
135-
#html_sidebars = {}
136-
137-
# Additional templates that should be rendered to pages, maps page names to
138-
# template names.
139-
#html_additional_pages = {}
140-
141-
# If false, no module index is generated.
142-
#html_domain_indices = True
143-
144-
# If false, no index is generated.
145-
#html_use_index = True
146-
147-
# If true, the index is split into individual pages for each letter.
148-
#html_split_index = False
149-
150-
# If true, links to the reST sources are added to the pages.
151-
#html_show_sourcelink = True
152-
153-
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
154-
#html_show_sphinx = True
155-
156-
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
157-
#html_show_copyright = True
158-
159-
# If true, an OpenSearch description file will be output, and all pages will
160-
# contain a <link> tag referring to it. The value of this option must be the
161-
# base URL from which the finished HTML is served.
162-
#html_use_opensearch = ''
163-
164-
# This is the file name suffix for HTML files (e.g. ".xhtml").
165-
#html_file_suffix = None
166-
167-
# Output file base name for HTML help builder.
168-
htmlhelp_basename = 'Fortran90doc'
169-
170-
171-
# -- Options for LaTeX output --------------------------------------------------
172-
173-
latex_elements = {
174-
# The paper size ('letterpaper' or 'a4paper').
175-
#'papersize': 'letterpaper',
176-
177-
# The font size ('10pt', '11pt' or '12pt').
178-
#'pointsize': '10pt',
179-
180-
# Additional stuff for the LaTeX preamble.
181-
#'preamble': '',
182-
}
183-
184-
# Grouping the document tree into LaTeX files. List of tuples
185-
# (source start file, target name, title, author, documentclass [howto/manual]).
186-
latex_documents = [
187-
('index', 'Fortran90.tex', u'Fortran90 Documentation',
188-
u'Ondřej Čertík', 'manual'),
189-
]
190-
191-
# The name of an image file (relative to this directory) to place at the top of
192-
# the title page.
193-
#latex_logo = None
194-
195-
# For "manual" documents, if this is true, then toplevel headings are parts,
196-
# not chapters.
197-
#latex_use_parts = False
198-
199-
# If true, show page references after internal links.
200-
#latex_show_pagerefs = False
201-
202-
# If true, show URL addresses after external links.
203-
#latex_show_urls = False
204-
205-
# Documents to append as an appendix to all manuals.
206-
#latex_appendices = []
207-
208-
# If false, no module index is generated.
209-
#latex_domain_indices = True
210-
211-
212-
# -- Options for manual page output --------------------------------------------
213-
214-
# One entry per manual page. List of tuples
215-
# (source start file, name, description, authors, manual section).
216-
man_pages = [
217-
('index', 'fortran90', u'Fortran90 Documentation',
218-
[u'Ondřej Čertík'], 1)
219-
]
220-
221-
# If true, show URL addresses after external links.
222-
#man_show_urls = False
223-
224-
225-
# -- Options for Texinfo output ------------------------------------------------
226-
227-
# Grouping the document tree into Texinfo files. List of tuples
228-
# (source start file, target name, title, author,
229-
# dir menu entry, description, category)
230-
texinfo_documents = [
231-
('index', 'Fortran90', u'Fortran90 Documentation', u'Ondřej Čertík',
232-
'Fortran90', 'One line description of project.', 'Miscellaneous'),
233-
]
234-
235-
# Documents to append as an appendix to all manuals.
236-
#texinfo_appendices = []
237-
238-
# If false, no module index is generated.
239-
#texinfo_domain_indices = True
240-
241-
# How to display URL addresses: 'footnote', 'no', or 'inline'.
242-
#texinfo_show_urls = 'footnote'

exts/math_dollar.py

Lines changed: 0 additions & 53 deletions
This file was deleted.

make.bat

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=.
11+
set BUILDDIR=_build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.https://www.sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

0 commit comments

Comments
 (0)