2e5daac978
* Updated marian-dev submodule - cmake changes required after the submodule update * Added workflows for building custom marian on mac and ubuntu * Renamed cmake option - Renamed USE_WASM_COMPATIBLE_SOURCES to USE_WASM_COMPATIBLE_SOURCE - Use proper compile defnitions |
||
|---|---|---|
| .. | ||
| _static/css | ||
| .gitignore | ||
| README.md | ||
| Unified_API.md | ||
| conf.py | ||
| index.rst | ||
| make.bat | ||
| marian-integration.md | ||
| references.bib | ||
| requirements.txt | ||
README.md
Marian NMT code documentation and library API
This directory contains code documentation and library API for developers of Marian NMT.
The documentation is generated using
Sphinx +
Breathe +
Doxygen +
Exhale.
The documentation source code is written in .rst or .md files with special directives that allow
to reference to C++ source code and documentation. The source documents are then build into static
HTML pages.
Installation
On Ubuntu 20.04, install the following packages:
sudo apt-get install python3 python3-pip python3-setuptools doxygen
Then set up a Python environment and install modules:
pip3 install virtualenv
virtualenv venv -p python3
source venv/bin/activate
pip install -r requirements.txt
Documentation building should also work on Windows, but it has not been tested.
Generation
The documentation can be generated by running:
make html
The website will be generated into build/html and accessible by opening index.html in your
browser.
Directories:
build- automatically output directory for HTML documentationdoxygen- automatically generated Doxygen XML filesapi- automatic library API generated with Exhale.rstand.mdfiles in this directory and its subdirectories are documentation source files_static- custom CSS and JavaScript files
Writing documentation
To be documented...