From 3155df7a7f3083fbc7e668450b6783810ec606cb Mon Sep 17 00:00:00 2001 From: Federica Brando <52486325+FedericaBrando@users.noreply.github.com> Date: Thu, 21 Mar 2024 13:00:53 +0100 Subject: [PATCH] fix: ReadTheDocs documentation build (#24) * add: gcc and downgrade python to 3.7 * fix: docs plugin explanation * fix: typo in docs --- .readthedocs.yaml | 4 +++- docs/user_guide/plugin_system.rst | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 78598a2..b4788e8 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -3,7 +3,9 @@ version: 2 build: os: "ubuntu-22.04" tools: - python: "3.12" + python: "3.7" + apt_packages: + - gcc # Build from the docs/ directory with Sphinx sphinx: diff --git a/docs/user_guide/plugin_system.rst b/docs/user_guide/plugin_system.rst index e0fbb41..572caae 100644 --- a/docs/user_guide/plugin_system.rst +++ b/docs/user_guide/plugin_system.rst @@ -20,7 +20,7 @@ visualize how the different classes are connected and composed with **OpenVarian | As we have mentioned before, the plugin has to be present on the `annotation` file in order to be used. Custom plugins will be placed in the -folder where the environment variable `OPENVAR_PLUGIN` points (`/home/user/.local/openvariant/` by default). +folder where the environment variable :bash:`OPENVAR_PLUGIN` points (:bash:`/home/user/.local/share/openvariant/` by default). The `Builder` will manage to find them and apply the data transformation. Plugins will inherit `Context` and `Plugin` as base classes for each plugin. These classes are described as it follows: