Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
ProMod3
Manage
Activity
Members
Plan
Jira
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Container registry
Model registry
Analyze
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
schwede
ProMod3
Commits
9a8f4d17
Commit
9a8f4d17
authored
11 years ago
by
Bienchen
Browse files
Options
Downloads
Plain Diff
Merge branch 'documentation' into develop
parents
30060b3c
20374ec0
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
doc/CMakeLists.txt
+6
-12
6 additions, 12 deletions
doc/CMakeLists.txt
doc/contributing.rst
+1
-2
1 addition, 2 deletions
doc/contributing.rst
with
7 additions
and
14 deletions
doc/CMakeLists.txt
+
6
−
12
View file @
9a8f4d17
...
...
@@ -119,22 +119,16 @@ add_dependencies(doc man)
# doctest target, one is enough for all
set
(
_SPHINX_DOCTEST_DIR
"
${
CMAKE_CURRENT_BINARY_DIR
}
/doctest"
)
file
(
MAKE_DIRECTORY
${
_SPHINX_DOCTEST_DIR
}
)
set
(
_SPHINX_DOCTEST_OUTPUT_TXT
"
${
_SPHINX_DOCTEST_DIR
}
/output.txt"
)
add_custom_command
(
OUTPUT
${
_SPHINX_DOCTEST_OUTPUT_TXT
}
MAIN_DEPENDENCY
"
${
_SPHINX_CONF_PY
}
"
DEPENDS
${
_RST_DEPS
}
${
_DOC_MODULE_DEPS
}
COMMAND
${
SPHINX_BINARY
}
-b doctest -c
"
${
_RST_SOURCE_DIR
}
"
"
${
_RST_SOURCE_DIR
}
"
"
${
_SPHINX_DOCTEST_DIR
}
"
)
add_custom_target
(
doctest DEPENDS
${
_SPHINX_DOCTEST_OUTPUT_TXT
}
)
add_custom_target
(
doctest
COMMAND
${
SPHINX_BINARY
}
-b doctest -c
"
${
_RST_SOURCE_DIR
}
"
"
${
_RST_SOURCE_DIR
}
"
"
${
_SPHINX_DOCTEST_DIR
}
"
DEPENDS
"
${
_SPHINX_CONF_PY
}
"
${
_RST_DEPS
}
${
_DOC_MODULE_DEPS
}
)
# linkcheck target
set
(
_SPHINX_LINKCHECK_DIR
"
${
CMAKE_CURRENT_BINARY_DIR
}
/linkcheck"
)
file
(
MAKE_DIRECTORY
${
_SPHINX_LINKCHECK_DIR
}
)
set
(
_SPHINX_LINKCHECK_OUTPUT_TXT
"
${
_SPHINX_LINKCHECK_DIR
}
/output.txt"
)
add_custom_command
(
OUTPUT
${
_SPHINX_LINKCHECK_OUTPUT_TXT
}
MAIN_DEPENDENCY
"
${
_SPHINX_CONF_PY
}
"
DEPENDS
${
_RST_DEPS
}
${
_DOC_MODULE_DEPS
}
COMMAND
${
SPHINX_BINARY
}
-b linkcheck -c
"
${
_RST_SOURCE_DIR
}
"
"
${
_RST_SOURCE_DIR
}
"
"
${
_SPHINX_LINKCHECK_DIR
}
"
)
add_custom_target
(
linkcheck DEPENDS
${
_SPHINX_LINKCHECK_OUTPUT_TXT
}
)
add_custom_target
(
linkcheck
COMMAND
${
SPHINX_BINARY
}
-b linkcheck -c
"
${
_RST_SOURCE_DIR
}
"
"
${
_RST_SOURCE_DIR
}
"
"
${
_SPHINX_LINKCHECK_DIR
}
"
DEPENDS
"
${
_SPHINX_CONF_PY
}
"
${
_RST_DEPS
}
${
_DOC_MODULE_DEPS
}
)
# register doctest & linkcheck with check
if
(
NOT DISABLE_DOCTEST
)
...
...
This diff is collapsed.
Click to expand it.
doc/contributing.rst
+
1
−
2
View file @
9a8f4d17
...
...
@@ -204,7 +204,7 @@ will provide you with a target ``test_awesome_feature.py_run``.
--------------------------------------------------------------------------------
Writing Documentation
--------------------------------------------------------------------------------
To create documentation, we use |sphinx|_ to go from |restructuredtext|
_
To create documentation, we use |sphinx|_ to go from |restructuredtext|
(|restructuredtext_abrv|) files and API documentation in source files to HTML
or man pages.
...
...
@@ -555,7 +555,6 @@ Now tests should be available by ``make check``, ``make codetest`` and
``make test_something.py_run``.
.. _restructuredtext: http://docutils.sourceforge.net/rst.html
.. |fedora| replace:: Fedora
.. |nameattr| replace:: :attr:`__name__`
...
...
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