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