Read the docs (#132)

[nlopt.git] / mkdocs.yml

diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644 (file)
index 0000000..0aa98bc
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,49 @@
+site_name: NLopt Documentation
+site_author: S. G. Johnson et al.
+repo_url: https://github.com/stevengj/NLopt/
+
+docs_dir: 'doc/docs'
+site_dir: 'doc/site'
+
+theme_dir: 'doc/nlopt-mkdocs-theme'
+theme: readthedocs
+
+python:
+   version: 2 # for unicode
+   setup_py_install: True
+
+markdown_extensions:
+    - wikilinks
+    - toc:
+        title: Table of Contents
+    - attr_list
+    - fenced_code
+    - mdx_math:
+        enable_dollar_delimiter: True
+
+extra_javascript: ['https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML','mathjaxhelper.js']
+
+pages:
+ - NLopt:
+    - Overview: index.md
+    - Release Notes: NLopt_release_notes.md
+    - FAQ: NLopt_FAQ.md
+ - NLopt manual:
+    - NLopt manual: NLopt_manual.md
+    - Introduction: NLopt_Introduction.md
+    - Installation: NLopt_Installation.md
+    - Tutorial:     NLopt_Tutorial.md
+ - NLopt reference:
+    - General reference: NLopt_Reference.md
+    - C++ reference: NLopt_C-plus-plus_Reference.md
+    - Fortran reference: NLopt_Fortran_Reference.md
+    - Matlab reference: NLopt_Matlab_Reference.md
+    - Python reference: NLopt_Python_Reference.md
+    - Guile reference: NLopt_Guile_Reference.md
+    - R reference:     NLopt_R_Reference.md
+    - Deprecated API reference: NLopt_Deprecated_API_Reference.md
+ - NLopt algorithms:
+    - NLopt algorithms: NLopt_Algorithms.md
+ - NLopt on Windows: NLopt_on_Windows.md
+ - License and Copyright: NLopt_License_and_Copyright.md
+ - Citing NLopt: Citing_NLopt.md