marian-nmt/marian
1
1
Fork 0
mirror of https://github.com/marian-nmt/marian.git synced 2024-11-05 01:31:46 +03:00
Code Issues Packages Projects Releases Wiki Activity
2a9c0bb377
marian/doc/README.md
Roman Grundkiewicz f88ded2ba8
Add documentation platform based on Sphinx+Doxygen+Breathe+Exhale (#803) 
* Setup Sphinx+Doxygen+Breathe+Exhale
* Remove links to modindex and search pages
* Enable Doxygen autobrief
2021-02-23 16:25:30 +00:00

1.6 KiB
Raw Blame History

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 documentation
  • doxygen - automatically generated Doxygen XML files
  • api - automatic library API generated with Exhale
  • .rst and .md files in this directory and its subdirectories are documentation source files
  • _static - custom CSS and JavaScript files

Writing documentation

To be documented...