Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
P
plugin_dbui
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Model registry
Monitor
Incidents
Analyze
Value stream analytics
Contributor 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
w2pext
plugin_dbui
Commits
ede558df
Commit
ede558df
authored
9 years ago
by
LE GAC Renaud
Browse files
Options
Downloads
Patches
Plain Diff
Fix the directory structure for documentation in the reference manual.
parent
76fe6e01
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/reference/keypoints.rst
+18
-9
18 additions, 9 deletions
docs/reference/keypoints.rst
with
18 additions
and
9 deletions
docs/reference/keypoints.rst
+
18
−
9
View file @
ede558df
...
@@ -21,21 +21,30 @@ Documentation
...
@@ -21,21 +21,30 @@ Documentation
format following the Google Python Style Guide (more details in the
format following the Google Python Style Guide (more details in the
sphinx napoleon_ extension).
sphinx napoleon_ extension).
The documentation is generated using sphinx_ generator.
We recommend to use following directory structure::
The master document is located in the directory
``myapplication/docs``. Its skeleton is created using the command
``sphinx-quickstart``::
> cd myapplication/docs
myapplications/docs
myapplications/docs/api
myapplications/docs/reference
myapplications/docs/user
The documentation is split in three blocks: the python API, the reference
manual for developers and the users manual.
The documentation is generated using the sphinx_ generator.
The first skeleton is obtained via the command
``sphinx-quickstart``, *e.g.*::
> cd myapplication/docs/api
> sphinx-quickstart
> sphinx-quickstart
Once the documentation written, the ``HTML`` version is
obtain
ed by::
Once the documentation written, the ``HTML`` version is
generat
ed by::
> cd myapplication
> cd myapplication
/docs/api
> sphinx-build -b html docs static/docs/
sphinx
> sphinx-build -b html docs static/docs/
api
The documentation can be seen from your application, via the URL
The documentation can be seen from your application, via the URL
``http(s)://mydomain/myapplication/static/docs/
sphinx
/index.html``
``http(s)://mydomain/myapplication/static/docs/
api
/index.html``
*Javascript widget documentation*
*Javascript widget documentation*
Write the documentation of your javascript classes using jsduck_.
Write the documentation of your javascript classes using jsduck_.
...
...
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