Skip to content

Commit

Permalink
update docs (#847)
Browse files Browse the repository at this point in the history
* update docs

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
PythonFZ and pre-commit-ci[bot] authored Nov 20, 2024
1 parent 80019ce commit b6de59d
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 21 deletions.
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
sys.path.insert(0, os.path.abspath(".."))

project = "ZnTrack"
copyright = "2023, zincwarecode <[email protected]>"
author = "zincwarecode <[email protected]>"
copyright = "2024, Fabian Zills"
author = "Fabian Zills"
version = importlib.import_module("zntrack").__version__

# -- General configuration ---------------------------------------------------
Expand Down
19 changes: 1 addition & 18 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,24 +71,7 @@ Class based Node
with zntrack.Project() as project:
node = AddNumbers(number1=10, number2=20)
project.run()
Function based Node
-------------------
.. code-block:: python
import zntrack
@zntrack.nodify(outs="number.txt", params={"number1": 10, "number2": 20})
def add_numbers(cfg: zntrack.NodeConfig):
with open(cfg.outs) as file:
file.write(str(cfg.params.number1 + cfg.params.number2))
with zntrack.Project() as project:
node = add_numbers()
project.run()
project.repro()
.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "zntrack"
version = "0.8.0a7"
version = "0.8.0a8"
description = "Create, Run and Benchmark DVC Pipelines in Python"
authors = ["zincwarecode <[email protected]>"]
license = "Apache-2.0"
Expand Down
3 changes: 3 additions & 0 deletions zntrack/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import importlib.metadata
import logging
import sys

Expand Down Expand Up @@ -52,3 +53,5 @@
channel.setFormatter(formatter)

logger.addHandler(channel)

__version__ = importlib.metadata.version("zntrack")

0 comments on commit b6de59d

Please sign in to comment.