Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
O
ogstools
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
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
Max Bittens
ogstools
Commits
02713c1f
Verified
Commit
02713c1f
authored
2 years ago
by
Lars Bilke
Browse files
Options
Downloads
Patches
Plain Diff
[docs] sphinx-quickstart.
parent
c9b27779
No related branches found
No related tags found
No related merge requests found
Changes
5
Hide whitespace changes
Inline
Side-by-side
Showing
5 changed files
docs/Makefile
+20
-0
20 additions, 0 deletions
docs/Makefile
docs/conf.py
+27
-0
27 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
pyproject.toml
+1
-1
1 addition, 1 deletion
pyproject.toml
with
103 additions
and
1 deletion
docs/Makefile
0 → 100644
+
20
−
0
View file @
02713c1f
# 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
+
27
−
0
View file @
02713c1f
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project
=
"
ogstools
"
copyright
=
"
2022, OpenGeoSys Community <info@opengeosys.org>
"
author
=
"
OpenGeoSys Community <info@opengeosys.org>
"
release
=
"
0.0.1
"
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions
=
[]
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
"
html_static_path
=
[
"
_static
"
]
This diff is collapsed.
Click to expand it.
docs/index.rst
0 → 100644
+
20
−
0
View file @
02713c1f
.. ogstools documentation master file, created by
sphinx-quickstart on Tue Dec 6 11:19:51 2022.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to ogstools'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 @
02713c1f
@ECHO
OFF
pushd
%~dp0
REM Command file for Sphinx documentation
if
"
%SPHINXBUILD%
"
==
""
(
set
SPHINXBUILD
=
sphinx
-build
)
set
SOURCEDIR
=
.
set
BUILDDIR
=
_build
%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.https://www.sphinx-doc.org/
exit /b 1
)
if "
%
1" == "" goto help
%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.
pyproject.toml
+
1
−
1
View file @
02713c1f
...
...
@@ -26,7 +26,7 @@ namespaces = false
msh2vtu
=
'ogstools.msh2vtu._cli:cli'
[project.optional-dependencies]
test
=
["pre-commit>
=
2.20
", "
tox>
=
4.1
", "
build
"]
test
=
["pre-commit>
=
2.20
", "
tox>
=
4.1
", "
build
"
, "
sphinx>
=
5.3
.
0
"
]
[tool.black]
line-length
=
80
...
...
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