diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 4c7d1e9..f930765 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -15,6 +15,6 @@ submodules: include: all build: - os: ubuntu-22.04 # https://docs.readthedocs.io/en/stable/config-file/v2.html#build-os + os: "ubuntu-lts-latest" # https://docs.readthedocs.io/en/stable/config-file/v2.html#build-os tools: - python: "mambaforge-22.9" # https://docs.readthedocs.io/en/stable/config-file/v2.html#build-tools-python, mamba instead of conda for better build performance \ No newline at end of file + python: "mambaforge-latest" # https://docs.readthedocs.io/en/stable/config-file/v2.html#build-tools-python, mamba instead of conda for better build performance diff --git a/docs/content/_archive/limitations.md b/docs/content/_archive/limitations.md new file mode 100644 index 0000000..2ca23e7 --- /dev/null +++ b/docs/content/_archive/limitations.md @@ -0,0 +1,21 @@ +# Limitations (ARCHIVED) + +## Network Connections + +### Downloading Databases (eg. USEEIO) + +Some functions of `bw2io` can download databases from the internet. For instance, [the following command](https://docs.brightway.dev/en/latest/api/bw2io/index.html#bw2io.useeio11) will download the USEEIO database: + +```python +bw2io.useeio11() +``` + +Unfortunately, due to [a limitation of Pyodide](https://pyodide.org/en/stable/project/roadmap.html#write-http-client-in-terms-of-web-apis): + +> Python packages make an extensive use of packages such as `requests` to synchronously fetch data. We currently can’t use such packages since sockets are not available in Pyodide. + +this command will fail with the following error: + +```python +ImportError: Can't connect to HTTPS URL because the SSL module is not available. +``` \ No newline at end of file diff --git a/docs/content/limitations.md b/docs/content/limitations.md index 2d5bef2..c715553 100644 --- a/docs/content/limitations.md +++ b/docs/content/limitations.md @@ -117,24 +117,4 @@ import bw2data import bw2calc import bw2io bw2io.add_example_database(searchable=False) -``` - -## Network Connections - -### Downloading Databases (eg. USEEIO) - -Some functions of `bw2io` can download databases from the internet. For instance, [the following command](https://docs.brightway.dev/en/latest/api/bw2io/index.html#bw2io.useeio11) will download the USEEIO database: - -```python -bw2io.useeio11() -``` - -Unfortunately, due to [a limitation of Pyodide](https://pyodide.org/en/stable/project/roadmap.html#write-http-client-in-terms-of-web-apis): - -> Python packages make an extensive use of packages such as `requests` to synchronously fetch data. We currently can’t use such packages since sockets are not available in Pyodide. - -this command will fail with the following error: - -```python -ImportError: Can't connect to HTTPS URL because the SSL module is not available. ``` \ No newline at end of file diff --git a/docs/environment.yaml b/docs/environment.yaml index 3f39685..38dc282 100644 --- a/docs/environment.yaml +++ b/docs/environment.yaml @@ -7,17 +7,17 @@ dependencies: - python=3.11 - ipython # sphinx - - sphinx=7.2.6 # core builder # https://anaconda.org/conda-forge/sphinx/files + - sphinx=7.3.7 # core builder # https://anaconda.org/conda-forge/sphinx/files # theme and extensions - - pydata-sphinx-theme=0.14.0 # website theme # https://anaconda.org/conda-forge/pydata-sphinx-theme/files - - myst-parser=2.0.0 # Markdown support # https://anaconda.org/conda-forge/myst-parser/files + - pydata-sphinx-theme=0.15.2 # website theme # https://anaconda.org/conda-forge/pydata-sphinx-theme/files + - myst-parser=3.0.1 # Markdown support # https://anaconda.org/conda-forge/myst-parser/files - sphinx-design=0.5.0 # responsive web component support # https://anaconda.org/conda-forge/sphinx-design/files - sphinx-notfound-page=1.0.0 # custom 404 page # https://anaconda.org/conda-forge/sphinx-notfound-page/files - sphinx-favicon=1.0.1 # for custom favicons # https://anaconda.org/conda-forge/sphinx-favicon/files - sphinx-copybutton=0.5.2 # for copy button in code blocks # https://anaconda.org/conda-forge/sphinx-copybutton/files - - linkify-it-py=2.0.0 # for beautified github links # https://anaconda.org/conda-forge/linkify-it-py/files + - linkify-it-py=2.0.3 # for beautified github links # https://anaconda.org/conda-forge/linkify-it-py/files # build process - - sphinx-autobuild=2021.3.14 # live-html support # https://anaconda.org/conda-forge/sphinx-autobuild/files + - sphinx-autobuild=2024.4.16 # live-html support # https://anaconda.org/conda-forge/sphinx-autobuild/files # web assembly - - jupyterlite-sphinx=0.9.3 # jupyterlite support # https://anaconda.org/conda-forge/jupyterlite-sphinx/files - - jupyterlite-pyodide-kernel=0.1.2 # pyodide support # https://anaconda.org/conda-forge/jupyterlite-pyodide-kernel/files \ No newline at end of file + - jupyterlite-sphinx=0.15.0 # jupyterlite support # https://anaconda.org/conda-forge/jupyterlite-sphinx/files + - jupyterlite-pyodide-kernel=0.3.1 # pyodide support # https://anaconda.org/conda-forge/jupyterlite-pyodide-kernel/files \ No newline at end of file