AudioReach Doc

This repository contains content to generate AudioReach documentation with Doxygen and Sphinx. The generated document is published at repository audioreach.github.io and hosted on GitHub Pages.

Required Tools/Software packages

• Doxygen

   sudo apt-add-repository universe
   sudo apt-get update
   sudo apt-get install doxygen
  

• Sphinx

   pip install -U sphinx
   pip install sphinx-rtd-theme
  

• Breathe

   pip install breathe
  

• NOTE AudioReach document is known to work with following tools and software package version:

   breathe 4.35.0
   Sphinx 5.3.0
   sphinx-rtd-theme 2.0.0
   doxygen 1.8.13
   Python 3.6.9
  

Steps to generate AudioReach documentation

1. Clone audioreach-doc repository.

   git clone https://github.com/Audioreach/audioreach-doc.git
   

2. Fetch API header files from AudioReach repositories to generate document:

   cd <audioreach-doc root dir>
   make sync_api_files
   

   This generates ./api_files directory with API files fetched to respective component sub-directories.

3. Run Doxygen using configuration file Doxyfile.in to generate the XML files:

   cd source
   doxygen ./Doxyfile.in
   

   This generates ./doxygen/xml/ directory which contains the output XML's generated by doxygen.

4. To generate Sphinx output with configuration file conf.py, run below command from audioreach-doc root directory:

   make html
   

   This command generates Sphinx output at audioreach-doc/build/html directory. To delete Sphinx output file and start over use make clean command.

5. Open index.html or drag it to browser, to view generated AudioReach document.

License

AudioReach Doc is licensed under the BSD-3-clause. Check out the LICENSE for more details.