Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
nk20
Manage
Activity
Members
Labels
Plan
Issues
32
Issue boards
Milestones
Wiki
Code
Merge requests
6
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
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
BDE
nk20
Commits
af664e48
Commit
af664e48
authored
4 years ago
by
ynerant
Browse files
Options
Downloads
Patches
Plain Diff
Initial setup for Sphinx
parent
296b94d2
No related branches found
Branches containing commit
No related tags found
Tags containing commit
2 merge requests
!146
Beta
,
!145
Docs
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
docs/Makefile
+20
-0
20 additions, 0 deletions
docs/Makefile
docs/conf.py
+62
-0
62 additions, 0 deletions
docs/conf.py
docs/index.rst
+20
-0
20 additions, 0 deletions
docs/index.rst
docs/make.bat
+35
-0
35 additions, 0 deletions
docs/make.bat
with
137 additions
and
0 deletions
docs/Makefile
0 → 100644
+
20
−
0
View file @
af664e48
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS
?=
SPHINXBUILD
?=
sphinx-build
SOURCEDIR
=
.
BUILDDIR
=
_build
# Put it first so that "make" without argument is like "make help".
help
:
@$(
SPHINXBUILD
)
-M
help
"
$(
SOURCEDIR
)
"
"
$(
BUILDDIR
)
"
$(
SPHINXOPTS
)
$(
O
)
.PHONY
:
help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%
:
Makefile
@$(
SPHINXBUILD
)
-M
$@
"
$(
SOURCEDIR
)
"
"
$(
BUILDDIR
)
"
$(
SPHINXOPTS
)
$(
O
)
This diff is collapsed.
Click to expand it.
docs/conf.py
0 → 100644
+
62
−
0
View file @
af664e48
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- 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.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project
=
'
Note Kfet 2020
'
copyright
=
'
2020, BDE ENS Paris-Saclay
'
author
=
'
BDE ENS Paris-Saclay
'
# The full version, including alpha/beta/rc tags
release
=
'
1.0.1
'
# -- 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
=
[
]
# Add any paths that contain templates here, relative to this directory.
templates_path
=
[
'
_templates
'
]
# 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
=
'
fr
'
# 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
'
]
# -- 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
'
# 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
'
]
This diff is collapsed.
Click to expand it.
docs/index.rst
0 → 100644
+
20
−
0
View file @
af664e48
.. Note Kfet 2020 documentation master file, created by
sphinx-quickstart on Thu Nov 26 00:58:58 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Note Kfet 2020's documentation!
==========================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
This diff is collapsed.
Click to expand it.
docs/make.bat
0 → 100644
+
35
−
0
View file @
af664e48
@ECHO
OFF
pushd
%~dp0
REM Command file for Sphinx documentation
if
"
%SPHINXBUILD%
"
==
""
(
set
SPHINXBUILD
=
sphinx
-build
)
set
SOURCEDIR
=
.
set
BUILDDIR
=
_build
if
"
%
1"
==
""
goto
help
%SPHINXBUILD%
>
NUL
2
>
NUL
if
errorlevel
9009
(
echo
.
echo
.The
'sphinx-build'
command
was
not
found
.
Make
sure
you
have
Sphinx
echo
.installed
,
then
set
the
SPHINXBUILD
environment
variable
to
point
echo
.to
the
full
path
of
the
'sphinx-build'
executable
.
Alternatively
you
echo
.may
add
the
Sphinx
directory
to
PATH
.
echo
.
echo
.If
you
don
't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD%
-M
%
1
%SOURCEDIR%
%BUILDDIR%
%SPHINXOPTS%
%O%
goto end
:help
%SPHINXBUILD%
-M help
%SOURCEDIR%
%BUILDDIR%
%SPHINXOPTS%
%O%
:end
popd
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