Name		Name	Last commit message	Last commit date
parent directory ..
source		source
Makefile		Makefile
Readme.md		Readme.md
make.bat		make.bat
pypi-management-readme.md		pypi-management-readme.md
release-management-readme.md		release-management-readme.md

Readme.md

Generate manual

Dynamic-grid-compliance-verification developer manual.

Clone the repository via:
```
git clone https://github.com/dynawo/dyn-grid-compliance-verification dgcv_repo
```
(you may of course use any name for the top-level directory, here "dgcv_repo".)
Cd into the repository and run the shell script named build_and_install.sh in developer mode. This builds the Python package, creates a Python virtual environment under the subdirectory dgcv_venv, and installs the package into it (together with all the necessary library dependencies, such as NumPy, etc. and the developer library dependencies, such as Sphinx, etc.).
```
    build_and_install.sh -d
```
Next, you must activate the virtual environment that has just been created:
```
source dgcv_venv/bin/activate
```

Using Sphinx it is possible to compile the manual to obtain a PDF document and/or an HTML version of it. Steps to compile the developer manual:

Cd into the manual directory (docs/manual_dev).
Run the Makefile script to compile the developer manual.
- Run make latexpdf to obtain a PDF file of the developer manual
- Run make html to obtain a HTML version of the developer manual
Sphinx creates a subdirectory xxx, within which we find the HTML version of the manual in the build/html/ directory and/or the dgcv-dev.pdf file in the build/latex/ directory.
```
build
├── doctrees
├── html
└── latex
```