Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: ReadTheDocs documentation build #24

Merged
merged 3 commits into from
Mar 21, 2024
Merged

fix: ReadTheDocs documentation build #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f16f80
add: gcc and downgrade python to 3.7
FedericaBrando Mar 21, 2024
5e3dc61
fix: docs plugin explanation
FedericaBrando Mar 21, 2024
d16432a
fix: typo in docs
FedericaBrando Mar 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/plugin_system.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Loading