Commit fbfce7b3 authored by Jack's avatar Jack
Browse files

Update documentation to include doc build instructions

parent 97304cf8
......@@ -13,16 +13,24 @@ The CASPER toolflow allows you to generate signal processing designs using MATLA
For more information about installing and using the CASPER Toolflow, see the project's [documentation](https://casper-toolflow.readthedocs.io).
CASPER also maintain a set of [tutorials](https://casper-tutorials.readthedocs.io), designed to introduce new users to the toolflow.
> ***Updating an Existing Toolflow Installation***
>
>You can always update your installation of `mlib_devel` by pulling updated code from this repository. If you do this, chances are you'll need to update your Simulink models to match your new `mlib_devel` libraries. A script is provided to automate this process. With your model open and active, in your MATLAB prompt, run
>```matlab
>update_casper_blocks(bdroot)
>```
> This script will resynchronize every CASPER block in your design with its latest library version. Depending on the size of your model, it may take many minutes to complete!
>As always, back up your designs before attempting such a major operation. And, if you experience problems, please raise Github issues!
If you want to build the documentation for a particular version of this repository you can do so by following [these instructions](docs/README.md).
## Tutorials
CASPER maintain a set of [tutorials](https://casper-tutorials.readthedocs.io), designed to introduce new users to the toolflow.
## Updating an Existing Toolflow Installation
You can always update your installation of `mlib_devel` by pulling updated code from this repository. If you do this, chances are you'll need to update your Simulink models to match your new `mlib_devel` libraries.
A script is provided to automate this process. With your model open and active, in your MATLAB prompt, run
```matlab
update_casper_blocks(bdroot)
```
This script will resynchronize every CASPER block in your design with its latest library version. Depending on the size of your model, it may take many minutes to complete!
As always, **back up your designs before attempting such a major operation**. And, if you experience problems, please raise Github issues!
## Directory structure
......
# [Sphinx documentation generation](http://www.sphinx-doc.org/en/master/)
## Getting Started:
- Create a fork of the tutorials_devel repository
## Getting Started (if you just want to build the documentation locally):
- `git clone` this repository
- Install the required tools using `pip install -r requirements.txt` in this directory.
- Follow the build instructions below
## Getting Started (If you want to modify this documentation):
- Create a fork of the this repository
- `git clone` the forked repository
- Install markdown first: `pip install markdown`
- Install the required tools using `pip install -r requirements.txt`
- Install the required tools using `pip install -r requirements.txt` in this directory.
- Make your changes and rebuild using the build instructions below.
- Push your changes to your fork of this repository
- Raise a pull request to https://github.com/casper-astro/mlib_devel
## Information:
- A [ReadtheDocs](https://readthedocs.org/) Sphinx theme `sphinx-rtd-theme` is used in order to host our documents on their platform.
......@@ -19,9 +26,9 @@
1. Open a terminal and `cd` into the `docs/` directory of your cloned repository
2. Build using `make html` command, which will build the documentation in the `_build/` directory.
3. Pay close attention to any warning that might appear.
4. Open a web browser and point it towards the build directory, then manually inspect the built html.
4. Open a web browser and point it towards the build directory, then manually inspect the built html, starting at `_build/index.html`.
Note: Please do not push a build directory to GitHub.
**Note: Please do not push a build directory to GitHub.**
## Resources:
- [ReadtheDocs](https://readthedocs.org/)
......
markdown
sphinx
sphinx_rtd_theme
recommonmark
PyYAML
numpy
\ No newline at end of file
numpy
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment