Skip to content
GitLab
Explore
Projects
Groups
Snippets
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
csst-pipeline
csst_proto
Commits
82cc8096
Commit
82cc8096
authored
2 years ago
by
BO ZHANG
Browse files
Options
Download
Email Patches
Plain Diff
tweaks
parent
eef772a2
dev
main
No related merge requests found
Pipeline
#182
passed with stages
in 15 seconds
Changes
2
Pipelines
1
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
doc/source/codestyle.rst
+2
-2
doc/source/codestyle.rst
doc/source/sphinxdoc.rst
+1
-1
doc/source/sphinxdoc.rst
with
3 additions
and
3 deletions
+3
-3
doc/source/codestyle.rst
+
2
-
2
View file @
82cc8096
...
...
@@ -84,8 +84,8 @@ For example,
python -m numpydoc --validate csst_proto.top_level_interface.flip_image
Markup language
===============
Markup language
s
===============
=
Markdown and reStructrured Text are two of popular markup languages.
reStructrured Text is used in Numpydoc docstrings as well as sphinx-based documentation.
Markdown is much easier and usually used to write `README` for a package.
...
...
This diff is collapsed.
Click to expand it.
doc/source/sphinxdoc.rst
+
1
-
1
View file @
82cc8096
s
phinx-based documentation
S
phinx-based documentation
==========================
The sphinx homepage:
...
...
This diff is collapsed.
Click to expand it.
Write
Preview
Supports
Markdown
0%
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!
Cancel
Please
register
or
sign in
to comment
Menu
Explore
Projects
Groups
Snippets