Skip to content

Commit

Permalink
Docs config by .readthedocs.yml (#28)
Browse files Browse the repository at this point in the history
* update-to-install-guide

* config file for docs building

* typo

* missin newline

* fix for error with _static
  • Loading branch information
jurajHasik committed May 28, 2019
1 parent ce8793f commit d04bef5
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 3 deletions.
23 changes: 23 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
builder: html
fail_on_warning: true
configuration: docs/source/conf.py

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml

# Optionally build your docs in additional formats such as PDF and ePub
formats: []

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = []

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
Expand Down
5 changes: 3 additions & 2 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,9 @@ If the command is successfull, we can enter the `build` directory and compile th
using `ninja`

.. code-block:: bash
$ cd build
$ ninja
$ cd build
$ ninja
Note that in the above example, `lapack` with `cblas` is used as default. If you want to use **mkl** instead, see below.

Expand Down

0 comments on commit d04bef5

Please sign in to comment.