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.

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

Update readthedocs.yaml #5

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 6 additions & 18 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,13 @@ version: 2
build:
os: "ubuntu-22.04"
tools:
python: "miniconda3-3.12-24.1" # note that libmamba-solver is available since 22.1
nodejs: "20" # maybe need to be also miniconda
jobs:
post_create_environment:
- python -m pip install --no-cache-dir .[docs]
- python -m pip install --exists-action=w --no-cache-dir -r docs/requirements.txt
- rabbitmq-server -detached
- sleep 10
- rabbitmq-diagnostics status
- verdi presto
- verdi daemon start
- verdi status
- aiida-pseudo install sssp -x PBEsol
- verdi group list
- cat /proc/cpuinfo | grep processor | wc -l

conda:
environment: docs/environment.yml
python: "3.11"

# Build from the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py

# Explicitly set the version of Python and its requirements
python:
install:
- requirements: docs/requirements.txt
12 changes: 6 additions & 6 deletions docs/source/web.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,40 +24,40 @@ WorkGraph table
---------------
The table shows all the workgraphs in the history. You can view the details of a workgraph by clicking it. You can also delete a workgraph by clicking the delete button.

.. image:: ../_static/images/web-job-management.png
.. image:: _static/images/web-job-management.png


WorkGraph detail
----------------
The detail page shows the details of a workgraph. You can view the details of each job in the workgraph. You can also view the logs of each job by clicking the log button.

.. image:: ../_static/images/web-detail.png
.. image:: _static/images/web-detail.png


WorkGraph logs
--------------
The logs page shows the logs of a job. You can view the logs of a job here.

.. image:: ../_static/images/web-logs.png
.. image:: _static/images/web-logs.png

Timeline
--------

The timeline page shows the timeline of the execution of the workgraph. You can view the timeline of the workgraph here.


.. image:: ../_static/images/web-timeline.png
.. image:: _static/images/web-timeline.png

Text Summary
------------
The text summary page shows the text summary of the workgraph. You can view the text summary of the workgraph here.

.. image:: ../_static/images/web-summary.png
.. image:: _static/images/web-summary.png


DataNode detail
----------------

The DataNode detail page shows the details of a DataNode. For a structure, it will show the 3D structure.

.. image:: ../_static/images/web-atoms-viewer.png
.. image:: _static/images/web-atoms-viewer.png
Loading