mkdocs.yml

   1 site_name: NLopt Documentation
   2 site_author: S. G. Johnson et al.
   3 repo_url: https://github.com/stevengj/NLopt/
   4
   5 docs_dir: 'doc/docs'
   6 site_dir: 'doc/site'
   7
   8 theme: readthedocs
   9
  10 python:
  11    version: 2 # for unicode
  12    setup_py_install: True
  13
  14 markdown_extensions:
  15     - wikilinks
  16     - toc:
  17         title: Table of Contents
  18     - attr_list
  19     - fenced_code
  20     - mdx_math:
  21         enable_dollar_delimiter: True
  22
  23 extra_javascript: ['https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML','mathjaxhelper.js']
  24
  25 pages:
  26  - NLopt:
  27     - Overview: index.md
  28     - Release Notes: NLopt_release_notes.md
  29     - FAQ: NLopt_FAQ.md
  30  - NLopt manual:
  31     - NLopt manual: NLopt_manual.md
  32     - Introduction: NLopt_Introduction.md
  33     - Installation: NLopt_Installation.md
  34     - Tutorial:     NLopt_Tutorial.md
  35  - NLopt reference:
  36     - General reference: NLopt_Reference.md
  37     - C++ reference: NLopt_C-plus-plus_Reference.md
  38     - Fortran reference: NLopt_Fortran_Reference.md
  39     - Matlab reference: NLopt_Matlab_Reference.md
  40     - Python reference: NLopt_Python_Reference.md
  41     - Guile reference: NLopt_Guile_Reference.md
  42     - R reference:     NLopt_R_Reference.md
  43     - Deprecated API reference: NLopt_Deprecated_API_Reference.md
  44  - NLopt algorithms:
  45     - NLopt algorithms: NLopt_Algorithms.md
  46  - NLopt on Windows: NLopt_on_Windows.md
  47  - License and Copyright: NLopt_License_and_Copyright.md
  48  - Citing NLopt: Citing_NLopt.md