Skip to content

Commit

Permalink
Merge pull request #12 from FAIRmat-NFDI/update_docs_home
Browse files Browse the repository at this point in the history
updated docs home grid
  • Loading branch information
JFRudzinski authored Jan 8, 2025
2 parents cb82c6b + 013a8e4 commit e5f2c2d
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 19 deletions.
4 changes: 0 additions & 4 deletions docs/how_to/install_this_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,3 @@ To run the test notebooks, create a jupyter kernel using your venv:
python -m ipykernel install --user --name=nomad_utility_workflows
```

## Main contributors
| Name | E-mail |
|------|------------|
| Joseph F. Rudzinski | [[email protected]](mailto:[email protected])
21 changes: 7 additions & 14 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,9 @@ How-to guides provide step-by-step instructions for a wide range of tasks, with

- [Install this plugin](how_to/install_this_plugin.md)
- [Use API functions](how_to/use_api_functions.md)
<!-- - [Create custom workflows](how_to/create_custom_workflows.md) -->
<!-- - [Contribute to this plugin](how_to/contribute_to_this_plugin.md)
- [Contribute to the documentation](how_to/contribute_to_the_documentation.md) -->
- [Create Custom Workflows](how_to/create_custom_workflows.md)
- [Add Custom Tasks](how_to/add_custom_tasks.md)

</div>

<div markdown="block">

### Examples

The following examples are available for demonstration purposes:

- [Workflows - Proof of Concept](examples/workflow_proof_of_concept.md)
- [Workflows - Simulation Protocol](examples/workflow_simulation_protocol.md)
- [Workflows - Adding Custom Tasks](examples/workflow_custom_tasks.md)

</div>

Expand All @@ -53,3 +41,8 @@ The reference section includes specifications for the relevant user-callable fun

</div>
</div>

## Main contributors
| Name | E-mail |
|------|------------|
| Joseph F. Rudzinski | [[email protected]](mailto:[email protected])
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ classifiers = [
]
name = "nomad-utility-workflows"
description = "A module with utilities for interacting with NOMAD via, e.g., a workflow manager."
version = "0.0.1"
dynamic = ["version"]
readme = "README.md"
requires-python = ">=3.9"
authors = [
Expand Down

0 comments on commit e5f2c2d

Please sign in to comment.