-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
158 additions
and
250 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| version: 2 | ||
|
|
||
| build: | ||
| os: ubuntu-22.04 | ||
| tools: | ||
| python: "3.12" | ||
|
|
||
| sphinx: | ||
| configuration: docs/conf.py | ||
|
|
||
| python: | ||
| install: | ||
| - requirements: docs/requirements.txt | ||
| - method: pip | ||
| path: . |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,191 +1,37 @@ | ||
| # | ||
| # Configuration file for the Sphinx documentation builder. | ||
| # | ||
| # This file does only contain a selection of the most common options. For a | ||
| # full list see the documentation: | ||
| # http://www.sphinx-doc.org/en/master/config | ||
|
|
||
| # -- Path 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. | ||
| # | ||
| # For the full list of built-in configuration values, see the documentation: | ||
| # https://www.sphinx-doc.org/en/master/usage/configuration.html | ||
| import os | ||
| import sys | ||
| from datetime import datetime | ||
|
|
||
| sys.path.insert(0, os.path.abspath("..")) | ||
|
|
||
| # on_rtd = os.environ.get('READTHEDOCS', None) == 'True' | ||
| on_rtd = os.environ.get('READTHEDOCS', None) == 'True' | ||
|
|
||
| # -- Project information ----------------------------------------------------- | ||
| # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information | ||
|
|
||
| project = "interrogatio" | ||
| copyright = f"{datetime.now().year}, Francesco Faraone." | ||
| author = "Francesco Faraone" | ||
|
|
||
| # The short X.Y version | ||
| version = "" | ||
| # The full version, including alpha/beta/rc tags | ||
| release = "1.0.0" | ||
|
|
||
| project = 'interrogatio' | ||
| copyright = '2024, Francesco Faraone' | ||
| author = 'Francesco Faraone' | ||
|
|
||
| # -- General configuration --------------------------------------------------- | ||
| # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration | ||
|
|
||
| # If your documentation needs a minimal Sphinx version, state it here. | ||
| # | ||
| # needs_sphinx = '1.0' | ||
|
|
||
| # Add any Sphinx extension module names here, as strings. They can be | ||
| # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | ||
| # ones. | ||
| extensions = [ | ||
| "sphinx.ext.autodoc", | ||
| ] | ||
|
|
||
| # if not on_rtd: # only import and set the theme if we're building docs locally | ||
| # import sphinx_rtd_theme | ||
| # html_theme = 'sphinx_rtd_theme' | ||
| # html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] | ||
|
|
||
|
|
||
| # 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. | ||
| # Usually you set "language" from the command line for these cases. | ||
| language = None | ||
|
|
||
| # 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 = ["_build", "Thumbs.db", ".DS_Store"] | ||
| extensions = ["sphinx.ext.autodoc"] | ||
|
|
||
| # The name of the Pygments (syntax highlighting) style to use. | ||
| pygments_style = None | ||
| if not on_rtd: | ||
| extensions.append("sphinx_rtd_theme") | ||
|
|
||
| templates_path = ['_templates'] | ||
| exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] | ||
|
|
||
| # -- Options for HTML output ------------------------------------------------- | ||
| # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output | ||
| html_theme = "alabaster" | ||
|
|
||
| # The theme to use for HTML and HTML Help pages. See the documentation for | ||
| # a list of builtin themes. | ||
| # | ||
|
|
||
| html_theme = "sphinx_rtd_theme" | ||
|
|
||
| # 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 paths that contain custom static files (such as style sheets) here, | ||
| # relative to this directory. They are copied after the builtin static files, | ||
| # 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 | ||
| # to template names. | ||
| # | ||
| # The default sidebars (for documents that don't match any pattern) are | ||
| # defined by theme itself. Builtin themes are using these templates by | ||
| # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', | ||
| # 'searchbox.html']``. | ||
| # | ||
| # html_sidebars = {} | ||
|
|
||
|
|
||
| # -- Options for HTMLHelp output --------------------------------------------- | ||
|
|
||
| # Output file base name for HTML help builder. | ||
| htmlhelp_basename = "interrogatiodoc" | ||
|
|
||
|
|
||
| # -- 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, | ||
| "interrogatio.tex", | ||
| "interrogatio Documentation", | ||
| "Francesco Faraone", | ||
| "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, "interrogatio", "interrogatio 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, | ||
| "interrogatio", | ||
| "interrogatio Documentation", | ||
| author, | ||
| "interrogatio", | ||
| "One line description of project.", | ||
| "Miscellaneous", | ||
| ), | ||
| ] | ||
|
|
||
|
|
||
| # -- Options for Epub output ------------------------------------------------- | ||
|
|
||
| # Bibliographic Dublin Core info. | ||
| epub_title = project | ||
|
|
||
| # The unique identifier of the text. This can be a ISBN number | ||
| # or the project homepage. | ||
| # | ||
| # epub_identifier = '' | ||
|
|
||
| # A unique identification for the text. | ||
| # | ||
| # epub_uid = '' | ||
|
|
||
| # A list of files that should not be packed into the epub file. | ||
| epub_exclude_files = ["search.html"] | ||
|
|
||
| if not on_rtd: | ||
| html_theme = 'sphinx_rtd_theme' | ||
|
|
||
| # -- Extension configuration ------------------------------------------------- | ||
| html_static_path = ['_static'] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| Sphinx==1.8.5 | ||
| docutils==0.17.1 | ||
| Sphinx==6.2.1 | ||
| docutils==0.19 |
Oops, something went wrong.