0.1.0 • Published 7 years ago

@navionics/nav_doxygen_theme v0.1.0

Weekly downloads
2
License
UNLICENSED
Repository
github
Last release
7 years ago

Navionics Doxygen Theme

Custom Navionics Theme for Doxygen Document engine

Hot To use it:

  • Move the directories template and Doxyfile in your preferred space
  • Edit the Doxyfile and provide the:
    • INPUT directory, it's the code directory. NOTE: This directory need to contain a Markdown file named README.mdused as homepage of documentation.
    • OUTPUT_DIRECTORY , it's the directory where you want the site
  • Open the terminal and run the command doxygen Doxifile

Hot To customize it:

It's a canonical NPM project driven by Grunt tools. If you want develop new feature you need to have NodeJS installed in your system.

The html assets it's developed with Bootstrap library.

Directory Content

  • demo/: The demo directory how to test the theme
  • template/: The template files and static assets
  • Doxyfile: Doxygen config file
  • Gruntfile.js: Grunt config file
  • package.json: Npm config file
  • LICENSE: License file
  • README.md: This file