Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
ev3-toolbox-matlab
Manage
Activity
Members
Labels
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Deploy
Releases
Container registry
Model registry
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Code review analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
mindstorms
ev3-toolbox-matlab
Commits
fc8a3643
Commit
fc8a3643
authored
7 years ago
by
Tim Stadtmann
Browse files
Options
Downloads
Patches
Plain Diff
Update readme.md
parent
06daf8ad
Branches
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
readme.md
+28
-0
28 additions, 0 deletions
readme.md
with
28 additions
and
0 deletions
readme.md
+
28
−
0
View file @
fc8a3643
...
@@ -70,5 +70,33 @@ and *doc functionname/classname*, or in the generated PDF/HTML documentation (in
...
@@ -70,5 +70,33 @@ and *doc functionname/classname*, or in the generated PDF/HTML documentation (in
TODO
TODO
### Building the documentation ###
### Building the documentation ###
The documentation is built using
[
Sphinx
](
http://www.sphinx-doc.org/en/stable/
)
and several
extensions:
[
matlabdomain
](
https://pypi.python.org/pypi/sphinxcontrib-matlabdomain
)
,
[
Napoleon
](
https://pypi.python.org/pypi/sphinxcontrib-napoleon
)
and
[
Sphinx Bootstrap Theme
](
https://pypi.python.org/pypi/sphinx-bootstrap-theme/
)
.
In order to setup your PC for building the documentation from the comments, you need to install these.
Using Ubuntu, you can use the following instructions (for other distros/OS's checkout the websites above):
```
sudo apt-get install python-sphinx
pip install sphinxcontrib-napoleon
pip install -U sphinxcontrib-matlabdomain
pip install sphinx_bootstrap_theme
```
You also need to setup your latex parser if you want Sphinx to generate pdfs:
```
sudo apt install texlive-latex-base
sudo apt install texlive-latex-extra
```
The build process for different outputs/platforms is controlled with a Makefile.
In the doc-directory, use the following commands to generate html or pdf files.
Other targets have not been tested.
```
make html
make latexpdf
```
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