Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
S
swh-docs
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package 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
Harsh Vardhan Mahawar
swh-docs
Commits
7998e3a0
Commit
7998e3a0
authored
7 years ago
by
Stefano Zacchiroli
Browse files
Options
Downloads
Patches
Plain Diff
dog fooding: load base sphinx configuration from package
parent
5cffb79e
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
docs/conf.py
+1
-83
1 addition, 83 deletions
docs/conf.py
swh/docs/sphinx/conf.py
+83
-1
83 additions, 1 deletion
swh/docs/sphinx/conf.py
swh/docs/sphinx/conf.py
+83
-1
83 additions, 1 deletion
swh/docs/sphinx/conf.py
with
167 additions
and
85 deletions
docs/conf.py
+
1
−
83
View file @
7998e3a0
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# General information about the project.
project
=
'
Software Heritage - Development Documentation
'
copyright
=
'
2015-2017, the Software Heritage developers
'
author
=
'
the Software Heritage developers
'
# -- General configuration ------------------------------------------------
# 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.napoleon
'
,
'
sphinx.ext.intersphinx
'
]
# 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 version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version
=
''
# The full version, including alpha/beta/rc tags.
release
=
''
# 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
=
'
en
'
# 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
'
]
# 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.
#
html_theme
=
'
alabaster
'
# 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
'
]
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping
=
{
'
https://docs.python.org/
'
:
None
}
# -- autodoc configuration ----------------------------------------------
autodoc_default_flags
=
[
'
members
'
,
'
undoc-members
'
]
from
swh.docs.sphinx.conf
import
*
# NoQA
This diff is collapsed.
Click to expand it.
swh/docs/sphinx/conf.py
deleted
120000 → 0
+
83
−
1
View file @
5cffb79e
..
/
..
/
..
/
docs
/
conf
.
py
\ No newline at end of file
This diff is collapsed.
Click to expand it.
swh/docs/sphinx/conf.py
0 → 100644
+
83
−
1
View file @
7998e3a0
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# General information about the project.
project
=
'
Software Heritage - Development Documentation
'
copyright
=
'
2015-2017, the Software Heritage developers
'
author
=
'
the Software Heritage developers
'
# -- General configuration ------------------------------------------------
# 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.napoleon
'
,
'
sphinx.ext.intersphinx
'
]
# 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 version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version
=
''
# The full version, including alpha/beta/rc tags.
release
=
''
# 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
=
'
en
'
# 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
'
]
# 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.
#
html_theme
=
'
alabaster
'
# 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
'
]
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping
=
{
'
https://docs.python.org/
'
:
None
}
# -- autodoc configuration ----------------------------------------------
autodoc_default_flags
=
[
'
members
'
,
'
undoc-members
'
]
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment