Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
toml
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Wiki
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
galactic
public
src
io
data
toml
Merge requests
!1
Toml
Code
Review changes
Check out branch
Download
Patches
Plain diff
Merged
Toml
develop
into
develop
Overview
10
Commits
6
Pipelines
0
Changes
17
9 unresolved threads
Hide all comments
Merged
Christophe Demko
requested to merge
develop
into
develop
5 years ago
Overview
10
Commits
6
Pipelines
0
Changes
17
9 unresolved threads
Hide all comments
Expand
👍
0
👎
0
Merge request reports
Compare
develop
develop (base)
and
latest version
latest version
e7df162e
6 commits,
5 years ago
17 files
+
695
−
196
Inline
Compare changes
Side-by-side
Inline
Show whitespace changes
Show one file at a time
Files
17
Search (e.g. *.vue) (Ctrl+P)
docs/conf.py
0 → 100644
+
219
−
0
Options
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# py-galactic documentation build configuration file, created by
# sphinx-quickstart on Sun Jan 14 18:35:19 2018.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# 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.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# General information about the project.
# Read from setup.cfg:
import
datetime
import
os
import
sys
project
=
"
Galactic TOML data reader
"
version
=
"
0.0.7.dev0
"
release
=
"
0.0.7.dev0
"
author
=
"
The Galactic Organization
"
year
=
datetime
.
date
.
today
().
year
copyright
=
"
2018-%s, The Galactic Organization
"
%
year
sys
.
path
.
insert
(
0
,
os
.
path
.
abspath
(
"
..
"
))
on_rtd
=
os
.
environ
.
get
(
"
READTHEDOCS
"
,
None
)
==
"
True
"
# -- 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
"
,
"
sphinx.ext.todo
"
,
"
sphinx.ext.coverage
"
,
"
sphinx.ext.mathjax
"
,
"
sphinx.ext.viewcode
"
,
"
sphinx.ext.imgconverter
"
,
"
sphinx.ext.intersphinx
"
,
"
sphinx.ext.napoleon
"
,
]
# Napoleon settings
napoleon_google_docstring
=
True
napoleon_numpy_docstring
=
True
# napoleon_include_init_with_doc = False
napoleon_include_init_with_doc
=
True
napoleon_include_private_with_doc
=
False
napoleon_include_special_with_doc
=
True
# napoleon_use_admonition_for_examples = False
# napoleon_use_admonition_for_notes = False
# napoleon_use_admonition_for_references = False
napoleon_use_admonition_for_examples
=
True
napoleon_use_admonition_for_notes
=
True
napoleon_use_admonition_for_references
=
True
napoleon_use_ivar
=
False
# napoleon_use_ivar = True
napoleon_use_param
=
True
napoleon_use_rtype
=
True
# intersphinx setting
intersphinx_mapping
=
{
"
python
"
:
(
"
https://docs.python.org/3
"
,
None
),
"
galactic
"
:
(
"
https://galactic.univ-lr.fr/docs/py-galactic-core/latest
"
,
None
),
}
autodoc_member_order
=
"
bysource
"
# 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
"
,
"
.ipynb
"
]
# 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 patterns also effect to html_static_path and html_extra_path
exclude_patterns
=
[
"
_build
"
,
"
**.ipynb_checkpoints
"
]
# The name of the Pygments (syntax highlighting) style to use.
pygments_style
=
"
sphinx
"
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos
=
True
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
if
not
on_rtd
:
# Generate uml diagrams
# 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
()]
# 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
=
[]
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# This is required for the alabaster theme
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
html_sidebars
=
{
"
**
"
:
[
"
relations.html
"
,
# needs 'show_related': True theme option to display
"
searchbox.html
"
,
]
}
html_favicon
=
"
thegalactic.ico
"
html_logo
=
"
icon.svg
"
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
# htmlhelp_basename = "py-galacticdoc"
# -- 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
,
"
py-galactic-data-reader-toml.tex
"
,
"
py-galactic-data-reader-toml Documentation
"
,
"
The Galactic Organization
"
,
"
manual
"
,
)
]
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, descriptions, authors, manual section).
# man_pages = [(master_doc, "py-galactic", "py-galactic 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, descriptions, category)
# texinfo_documents = [
# (
# master_doc,
# "py-galactic",
# "py-galactic Documentation",
# author,
# "py-galactic",
# "One line descriptions of project.",
# "Miscellaneous",
# )
# ]
Loading