Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
ycai
simbricks
Commits
205d2215
Commit
205d2215
authored
May 06, 2024
by
Jonas Kaufmann
Committed by
Antoine Kaufmann
May 08, 2024
Browse files
doc: auto-format Python files
parent
32b543cf
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
26 additions
and
25 deletions
+26
-25
Makefile
Makefile
+4
-4
doc/conf.py
doc/conf.py
+22
-21
No files found.
Makefile
View file @
205d2215
...
...
@@ -78,22 +78,22 @@ lint-clang-format:
lint-yapf
:
yapf
--recursive
--diff
\
--exclude
experiments/simbricks/orchestration/utils/graphlib.py
\
--
results/ experiments/
--
results/ experiments/
doc/
format-yapf
:
yapf
--recursive
--in-place
\
--exclude
experiments/simbricks/orchestration/utils/graphlib.py
\
--exclude
experiments/out/
\
--
results/ experiments/
--
results/ experiments/
doc/
lint-isort
:
isort
--diff
\
--skip
experiments/simbricks/orchestration/utils/graphlib.py
\
results/ experiments/
results/ experiments/
doc/
format-isort
:
isort
--skip
experiments/simbricks/orchestration/utils/graphlib.py
\
results/ experiments/
results/ experiments/
doc/
lint
:
lint-cpplint lint-clang-format lint-python
lint-all
:
lint lint-clang-tidy typecheck-python
...
...
doc/conf.py
View file @
205d2215
...
...
@@ -6,7 +6,6 @@
# 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,
...
...
@@ -15,6 +14,7 @@
import
os
import
sys
sys
.
path
.
append
(
os
.
path
.
abspath
(
'../experiments'
))
sys
.
path
.
append
(
os
.
path
.
abspath
(
'.'
))
from
external_links
import
*
...
...
@@ -32,7 +32,6 @@ version = ''
# The full version, including alpha/beta/rc tags
release
=
''
# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
...
...
@@ -77,9 +76,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
pygments_style
=
None
# Default options for autodoc extension.
autodoc_default_options
=
{
'member-order'
:
'bysource'
}
autodoc_default_options
=
{
'member-order'
:
'bysource'
}
# Whether to number figures.
numfig
=
True
...
...
@@ -127,7 +124,6 @@ html_css_files = [
# Output file base name for HTML help builder.
htmlhelp_basename
=
'SimBricksdoc'
# -- Options for LaTeX output ------------------------------------------------
latex_elements
=
{
...
...
@@ -152,20 +148,20 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents
=
[
(
master_doc
,
'simbricks.tex'
,
'SimBricks Documentation'
,
'Antoine Kaufmann'
,
'manual'
),
(
master_doc
,
'simbricks.tex'
,
'SimBricks Documentation'
,
'Antoine Kaufmann'
,
'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
,
'simbricks'
,
'SimBricks Documentation'
,
[
author
],
1
)
]
man_pages
=
[(
master_doc
,
'simbricks'
,
'SimBricks Documentation'
,
[
author
],
1
)]
# -- Options for Texinfo output ----------------------------------------------
...
...
@@ -173,12 +169,17 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents
=
[
(
master_doc
,
'simbricks'
,
'SimBricks Documentation'
,
author
,
'SimBricks'
,
'One line description of project.'
,
'Miscellaneous'
),
(
master_doc
,
'simbricks'
,
'SimBricks Documentation'
,
author
,
'SimBricks'
,
'One line description of project.'
,
'Miscellaneous'
),
]
# -- Options for Epub output -------------------------------------------------
# Bibliographic Dublin Core info.
...
...
@@ -196,13 +197,13 @@ epub_title = project
# A list of files that should not be packed into the epub file.
epub_exclude_files
=
[
'search.html'
]
breathe_projects
=
{
'simbricks'
:
'doxygen/xml/'
}
breathe_projects
=
{
'simbricks'
:
'doxygen/xml/'
}
breathe_default_project
=
'simbricks'
import
os
#################################################################################
# For RTD
import
subprocess
,
os
import
subprocess
# Check if we're running on Read the Docs' servers
read_the_docs_build
=
os
.
environ
.
get
(
'READTHEDOCS'
,
None
)
==
'True'
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment