Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
S
Sphinx-Documentation
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
Container registry
Model registry
Operate
Environments
Monitor
Incidents
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
GitLab community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Marc Feger
Sphinx-Documentation
Commits
d2796a83
Commit
d2796a83
authored
Mar 26, 2018
by
Marc Feger
Browse files
Options
Downloads
Patches
Plain Diff
Modify README
parent
aedac0a2
Branches
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+46
-0
46 additions, 0 deletions
README.md
with
46 additions
and
0 deletions
README.md
+
46
−
0
View file @
d2796a83
...
...
@@ -8,3 +8,49 @@ Install Sphinx with:
Create a directory over the lever of the code.
Your folder structure should look like this:
Project:
-
Documentation
-
Code
Then add Doc-Strings to your code. Those Doc-Strings should look like this:
"""
some explenation
:param a [description]
...
:return [description]
"""
Then navigate into the documentation folder and run:
sphinx-quickstart
Follow the questions like this:
Enter the root path for documentation.
> Root path for the documentation [.]:
> Separate source and build directories (y/n) [n]:
> Project name: Sphinx-Documentation
> Author name(s): Marc Feger
> Project version []: 1.0
> Project release [1.0]: 1.0
> Project language [en]:
> Source file suffix [.rst]:
> Name of your master document (without suffix) [index]:
> autodoc: automatically insert docstrings from modules (y/n) [n]: y
> doctest: automatically test code snippets in doctest blocks (y/n) [n]:
> intersphinx: link between Sphinx documentation of different projects (y/n) [n]: y
> todo: write "todo" entries that can be shown or hidden on build (y/n) [n]:
> coverage: checks for documentation coverage (y/n) [n]:
> imgmath: include math, rendered as PNG or SVG images (y/n) [n]:
> mathjax: include math, rendered in the browser by MathJax (y/n) [n]:
> ifconfig: conditional inclusion of content based on config values (y/n) [n]:
> viewcode: include links to the source code of documented Python objects (y/n) [n]: y
> githubpages: create .nojekyll file to publish the document on GitHub pages (y/n) [n]: y
> Create Makefile? (y/n) [y]: y
> Create Windows command file? (y/n) [y]: y
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