Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Fix] Add Readme for doc generation #1813

Merged
merged 2 commits into from
Apr 30, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions doc/README.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Documentation Generation

## Index

- ``Devel``: Contains *.rst files for Developer Guide
- ``examples``: Dipy app showcases. Add any tutorial here
- ``examples_built``: keep it empty. Only for examples generation
- ``releases_notes``: Contains all API changes / PR-issues resolve for a specific release
- ``sphinx_ext``: Sphinx custom plugins
- ``theory``: Diffusion theory + FAQ files
- ``tools``: Scripts to generate some part of the documentation like API
- ``build``: Contains the generated documentation
- ``_static``: Contains images, css, js for Sphinx to look at
- ``_templates``: Contains html layout for custom sphinx design

## Doc generation steps:

### Installing requirements

```bash
$ pip install -U -r doc-requirements.txt
```

### Generate all the Documentation

#### Under Linux and OSX

```bash
$ make -C . clean && make -C . html
```

#### Under Windows

```bash
$ ./make.bat clean
$ ./make.bat html
```
13 changes: 13 additions & 0 deletions doc/doc-requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
cython
numpy
scipy
nibabel>=2.3.1
h5py
cvxpy
pandas
tables
matplotlib
fury
scikit-learn
scikit-image
statsmodels