diff --git a/README.md b/README.md index 5055b3e9..4fcd4bd8 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ It is recommended to install poetry system-wide via the command below or cd oemof-B3 3. Create virtual environment using conda: - conda env create environment.yml + conda env create -f environment.yml 4. Activate environment: conda activate oemof-B3 diff --git a/docs/conf.py b/docs/conf.py index e277f97d..4717e368 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,7 +23,7 @@ author = 'Reiner Lemoine Institut' # The full version, including alpha/beta/rc tags -release = '0.0.4dev' +release = '0.0.5dev' # -- General configuration --------------------------------------------------- diff --git a/docs/docs_requirements.txt b/docs/docs_requirements.txt index e32f9514..2d729bea 100644 --- a/docs/docs_requirements.txt +++ b/docs/docs_requirements.txt @@ -1,4 +1,4 @@ # Duplicates the docs requirements in pyproject.toml, but is necessary for readthedocs (rtd does not allow to poetry install -E docs). -sphinx +sphinx>=5.0.0 sphinx-rtd-theme>=0.5.1 sphinxcontrib_bibtex \ No newline at end of file diff --git a/docs/getting_started.rst b/docs/getting_started.rst index af91ce1e..bf384bc4 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -41,7 +41,7 @@ It is recommended to install poetry system-wide via the command below or :: - conda env create environment.yml + conda env create -f environment.yml 4. Activate environment: diff --git a/docs/whats_new.rst b/docs/whats_new.rst index 0d8eda9b..ca543180 100644 --- a/docs/whats_new.rst +++ b/docs/whats_new.rst @@ -4,6 +4,7 @@ What's new ~~~~~~~~~~ +.. include:: whats_new/v0-0-4.rst .. include:: whats_new/v0-0-3.rst .. include:: whats_new/v0-0-2.rst .. include:: whats_new/v0-0-1.rst diff --git a/docs/whats_new/v0-0-4.rst b/docs/whats_new/v0-0-4.rst index 007e504e..64ba0600 100644 --- a/docs/whats_new/v0-0-4.rst +++ b/docs/whats_new/v0-0-4.rst @@ -2,13 +2,22 @@ v0.0.4 ====== # New features +* oemof-B3 now runs with latest release of oemoflex -> v0.0.3 +* Hence it runs with oemof.tabular -> version v0.0.5 # Bug fixes - -# Documentation - -# Tests - -# Other changes +* Wrong zenodo link to raw data has been fixed +* documentation build has been fixed (commit 07084684e8897ac34327a41bae990a3d881226d8) # Contributors +- jnnr +- MaGering +- SabineHaas +- juliusmeier +- henhuy +- monika-o +- c-moeller +- Stefanie08 +- chrwm +- khelfen +- mjazimm \ No newline at end of file diff --git a/docs/whats_new/v0-0-5.rst b/docs/whats_new/v0-0-5.rst new file mode 100644 index 00000000..58011155 --- /dev/null +++ b/docs/whats_new/v0-0-5.rst @@ -0,0 +1,23 @@ +v0.0.4 +====== + +# New features + +# Bug fixes + +# Documentation + +# Tests + +# Contributors +- jnnr +- MaGering +- SabineHaas +- juliusmeier +- henhuy +- monika-o +- c-moeller +- Stefanie08 +- chrwm +- khelfen +- mjazimm diff --git a/poetry.lock b/poetry.lock index d813980f..67866327 100644 --- a/poetry.lock +++ b/poetry.lock @@ -3346,26 +3346,26 @@ files = [ [[package]] name = "sphinx" -version = "4.5.0" +version = "5.3.0" description = "Python documentation generator" optional = true python-versions = ">=3.6" files = [ - {file = "Sphinx-4.5.0-py3-none-any.whl", hash = "sha256:ebf612653238bcc8f4359627a9b7ce44ede6fdd75d9d30f68255c7383d3a6226"}, - {file = "Sphinx-4.5.0.tar.gz", hash = "sha256:7bf8ca9637a4ee15af412d1a1d9689fec70523a68ca9bb9127c2f3eeb344e2e6"}, + {file = "Sphinx-5.3.0.tar.gz", hash = "sha256:51026de0a9ff9fc13c05d74913ad66047e104f56a129ff73e174eb5c3ee794b5"}, + {file = "sphinx-5.3.0-py3-none-any.whl", hash = "sha256:060ca5c9f7ba57a08a1219e547b269fadf125ae25b06b9fa7f66768efb652d6d"}, ] [package.dependencies] alabaster = ">=0.7,<0.8" -babel = ">=1.3" -colorama = {version = ">=0.3.5", markers = "sys_platform == \"win32\""} -docutils = ">=0.14,<0.18" -imagesize = "*" -Jinja2 = ">=2.3" -packaging = "*" -Pygments = ">=2.0" +babel = ">=2.9" +colorama = {version = ">=0.4.5", markers = "sys_platform == \"win32\""} +docutils = ">=0.14,<0.20" +imagesize = ">=1.3" +Jinja2 = ">=3.0" +packaging = ">=21.0" +Pygments = ">=2.12" requests = ">=2.5.0" -snowballstemmer = ">=1.1" +snowballstemmer = ">=2.0" sphinxcontrib-applehelp = "*" sphinxcontrib-devhelp = "*" sphinxcontrib-htmlhelp = ">=2.0.0" @@ -3375,8 +3375,8 @@ sphinxcontrib-serializinghtml = ">=1.1.5" [package.extras] docs = ["sphinxcontrib-websupport"] -lint = ["docutils-stubs", "flake8 (>=3.5.0)", "isort", "mypy (>=0.931)", "types-requests", "types-typed-ast"] -test = ["cython", "html5lib", "pytest", "pytest-cov", "typed-ast"] +lint = ["docutils-stubs", "flake8 (>=3.5.0)", "flake8-bugbear", "flake8-comprehensions", "flake8-simplify", "isort", "mypy (>=0.981)", "sphinx-lint", "types-requests", "types-typed-ast"] +test = ["cython", "html5lib", "pytest (>=4.6)", "typed_ast"] [[package]] name = "sphinx-rtd-theme" @@ -4004,4 +4004,4 @@ preprocessing = ["geopandas"] [metadata] lock-version = "2.0" python-versions = ">=3.10, <3.11" -content-hash = "002cb501ea89ecf1d859372ea7f49d45a6d24ba535d8b8254f6844c4816d0cc2" +content-hash = "35bb03435de68d13e8d111d110bf880c5f71d7582f82aed2b165c665d8a508f7" diff --git a/pyproject.toml b/pyproject.toml index 6b4c4e23..caaf9b35 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "oemof-B3" -version = "0.0.4dev" +version = "0.0.5dev" description = "oemof-B3 - an open-source energy system model for Brandenburg/Berlin" authors = [ "Jann Launer ", @@ -26,7 +26,7 @@ pyyaml = ">=6.0" dynaconf = "^3.1.7" snakemake = ">=5" oemoflex = {git = "https://github.com/rl-institut/oemoflex.git", rev = "0.0.3"} -Sphinx = {version = "^4.3.2", optional = true} +Sphinx = {version = ">=5.0", optional = true} sphinx-rtd-theme = {version = "^1.0.0", optional = true} sphinxcontrib-bibtex = {version = "^2.4.1", optional = true} docutils = "^0.17"