Skip to content

Commit

Permalink
Fix read the docs build (#893)
Browse files Browse the repository at this point in the history
* Fix read the docs build

* Configuring metadata file for bbp sphinx theme

* Removing extra metadata config variable

* Debugging version

* Fix wrong versioning

* Adding contributors to metadata
  • Loading branch information
NadirRoGue committed Aug 17, 2020
1 parent 53dedce commit c82750f
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 4 deletions.
2 changes: 1 addition & 1 deletion python/doc/source/api_circuitexplorer_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ using the following parameter:
--plugin braynsCircuitExplorer
The module exopses the following API.
The module exposes the following API.

----

Expand Down
13 changes: 10 additions & 3 deletions python/doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,15 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

import os
import sys
from brayns.version import VERSION
sys.path.insert(0, os.path.abspath('../../brayns'))

from version import MINIMAL_VERSION

from os import path
sys.path.insert(0, path.dirname(path.dirname(path.abspath('../python'))))


# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
Expand Down Expand Up @@ -52,7 +59,7 @@
# built documents.
#
# The short X.Y version.
version = VERSION
version = MINIMAL_VERSION
# The full version, including alpha/beta/rc tags.
release = version

Expand Down Expand Up @@ -104,7 +111,7 @@
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
"metadata_distribution": "brayns"
"metadata_file": "metadata.json"
}

# Add any paths that contain custom themes here, relative to this directory.
Expand Down
17 changes: 17 additions & 0 deletions python/doc/source/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"name": "brayns",
"description": "Brayns python API",
"version": "1.0.1",
"repository": {
"type": "git",
"url": "https://github.com/BlueBrain/Brayns.git"
},
"keywords": ["brayns", "raytracing", "bbp", "BlueBrain"],
"author": "Blue Brain Project",
"license": "LGPLv3",
"bugs": {
"url": "https://github.com/BlueBrain/Brayns/issues"
},
"homepage": "https://github.com/BlueBrain/Brayns",
"contributors":["Daniel Nachbaur", "Cyrille Favreau", "Jonas Karlsson", "Roland Groza", "Nadir Roman", "Grigori Chevtchenko", "Pawel Podhajski", "Adrien Devresse", "Sebastien Speierer", "Fabien Petitjean"]
}

0 comments on commit c82750f

Please sign in to comment.