diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 93564e8..9c6e31c 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,20 +1,20 @@ FROM ubuntu:24.04 -ARG CACHEBUST=1 +ARG PLANTUML_VERSION=1.2024.6 +ARG PYTHON_VERSION=3.12 SHELL ["/bin/bash","-c"] -ENV TZ="Europe/Berlin" -ENV LC_ALL en_US.UTF-8 -ENV LANG en_US.UTF-8 -ENV LANGUAGE en_US.UTF-8 - # Update package lists RUN apt-get update && apt-get upgrade -y # Install essential packages RUN DEBIAN_FRONTEND=noninteractive apt install -y \ - build-essential libssl-dev zlib1g-dev libbz2-dev libssl-dev \ + build-essential \ + libssl-dev \ + zlib1g-dev \ + libbz2-dev \ + libssl-dev \ git \ curl \ wget \ @@ -26,20 +26,29 @@ RUN DEBIAN_FRONTEND=noninteractive apt install -y \ nano \ jq \ openjdk-17-jdk \ - python3.12 python3.12-venv python3-pip-whl python3-pip + python${PYTHON_VERSION} \ + python${PYTHON_VERSION}-venv \ + python3-pip-whl \ + python3-pip + +RUN apt install -y pipx RUN mkdir -p /usr/share/plantuml -RUN wget --no-check-certificate \ - https://github.com/plantuml/plantuml/releases/download/v1.2024.5/plantuml-mit-1.2024.5.jar \ +RUN wget \ + https://github.com/plantuml/plantuml/releases/download/v${PLANTUML_VERSION}/plantuml-mit-${PLANTUML_VERSION}.jar \ -O /usr/share/plantuml/plantuml.jar -RUN update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.12 311 +RUN update-alternatives --install /usr/bin/python3 python3 /usr/bin/python${PYTHON_VERSION} 311 +RUN ln -s /usr/bin/python3 /usr/bin/python COPY ./uid_entrypoint /usr/local/bin/ RUN chmod 777 /usr/local/bin/uid_entrypoint -COPY requirements.txt /tmp/requirements.txt +ENV PIPX_HOME=/opt/pipx \ + PIPX_BIN_DIR=/usr/local/bin -USER ubuntu +RUN pipx ensurepath +RUN pipx install poetry==1.8.3 +USER ubuntu ENTRYPOINT [ "uid_entrypoint"] diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index f45bac0..7c194f1 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,11 +1,30 @@ { - "name": "Python Environment", - // "image": "sphinx-ubuntu-24.04:0.2", - "build": { - "dockerfile": "Dockerfile", - "context": ".." - }, - "workspaceFolder": "/workspace", - "runArgs": ["-v", "${localWorkspaceFolder}:/workspace"], - "postCreateCommand": "./uid_entrypoint" + "name": "sphinx-needs-data-explorer-dc", + "build": { + "dockerfile": "Dockerfile", + "context": ".." + }, + "runArgs": [ + "-v","${localWorkspaceFolder}:/workspace" + ], + "workspaceFolder": "/workspace", + "postCreateCommand": "./uid_entrypoint", + "mounts": [ + "type=bind,readonly,source=/etc/localtime,target=/etc/localtime" + ], + "containerEnv": { + "GITHUB_TOKEN": "${localEnv:GITHUB_TOKEN}", + "GITHUB_USER": "${localEnv:GITHUB_USER}", + "LC_ALL": "en_US.UTF-8", + "LANG": "en_US.UTF-8", + "LANGUAGE": "en_US.UTF-8" + }, + "customizations": { + "vscode": { + "extensions": [ + "ms-python.python", + "ms-python.debugpy" + ] + } + } } diff --git a/.gitignore b/.gitignore index e76e8a6..5a96b6e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,11 @@ .DS_Store .venv +myvenv build +doc/build dist -.vscode - +/*.json +/*.zip +/*.bak +docs +sphinx_needs_data_explorer/_static/sphinx_needs_data_explorer_bak*.html diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..5bc02ed --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,28 @@ +{ + "version": "0.3.0", + "configurations": [ + { + "name": "Python: Sphinx Module", + "type": "debugpy", + "purpose": [ + "debug-in-terminal" + ], + "request": "launch", + "module": "sphinx", + "console": "integratedTerminal", + "justMyCode": false, + "stopOnEntry": true, + "args": [ + "-b", + "html", + "source", + "build", + "-Ea" + ], + "cwd": "${workspaceFolder}/doc", + "env": { + "TEST": "true", + } + }, + ] +} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..cb336bf --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,15 @@ +{ + "esbonio.sphinx.buildDir": "${workspaceFolder}/_build/html", + "esbonio.sphinx.confDir": "${workspaceFolder}/doc/source", + "esbonio.server.showDeprecationWarnings": "false", + "esbonio.server.enabled": true, + "sphinx.quiet": true, + "sphinx.silent": true, + "sphinx.verbosity": 0, + "restructuredtext.syntaxHighlighting.disabled": true, + "plantuml.exportOutDir": "${workspaceFolder}/out", + "plantuml.exportSubFolder": false, + "editor.tabSize": 2, + "editor.insertSpaces": true, + "editor.detectIndentation": false +} \ No newline at end of file diff --git a/MANIFEST.in b/MANIFEST.in deleted file mode 100644 index 818cf3b..0000000 --- a/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -global-exclude .DS_Store -include README_pypi.md diff --git a/Makefile b/Makefile index 260b8aa..ed081ad 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,6 @@ .ONESHELL: SHELL=/bin/bash +.SHELLFLAGS = -e -c UNAME := $(shell uname 2>/dev/null || echo Windows) @@ -24,29 +25,16 @@ helpx: $(VERBOSE).SILENT: echo -doc/.venv: - python3 -m venv doc/.venv - source doc/.venv/bin/activate - pip install -r doc/requirements.txt - pip install --upgrade pip - -install: doc/.venv - source doc/.venv/bin/activate +install: rm -rf build dist doc/build - python -m build --sdist --wheel - pip uninstall sphinx-needs-data-explorer -y - pip install dist/sphinx_needs_data_explorer*.whl + poetry install -prep-release: doc/.venv - source doc/.venv/bin/activate - python -m pip install --upgrade twine +prep-release: rm -rf build dist doc/build - python -m build --sdist - tar -tf dist/* - -upload-package: - source doc/.venv/bin/activate - python -m twine upload dist/* --verbose + poetry install +# poetry build + poetry build -f sdist + tar -tf dist/*.tar.gz installx: pip uninstall sphinx-needs-data-explorer -y @@ -87,19 +75,19 @@ new-install: echo source $(VENV)/bin/activate +test-package-cur: + $(MAKE) test-package BRANCH=`git branch | awk '$$1=="*"{print $$2}'` + test-package: $(eval WDIR=/tmp/test) + $(eval BRANCH=updates6) mkdir -p $(WDIR) rm -rf $(WDIR)/* cd $(WDIR) - git clone -b new-features5 --single-branch \ + git clone -b $(BRANCH) --single-branch \ https://github.com/mi-parkes/sphinx-needs-data-explorer.git cd sphinx-needs-data-explorer -# cp $(CURDIR)/pyproject.toml . - python3 -m venv .venv - source .venv/bin/activate - python -m pip install --upgrade pip - pip install poetry +# poetry install --only test,docs poetry install poetry build poetry run task doc @@ -110,4 +98,7 @@ test-package-show: $(MAKE) webserver show show-package: - tar -tvf dist/sphinx_needs_data_explorer-0.9.0.tar.gz + tar -tvf dist/sphinx_needs_data_explorer-*.tar.gz + +clean-dc: + docker images | awk '$$1==""{print "docker rmi "$$3}' | bash diff --git a/README.md b/README.md index 1420ff6..fe70646 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,13 @@
-The `sphinx_needs_data_explorer` is a web application written in HTML, CSS, and JavaScript, provided as a [Sphinx](https://www.sphinx-doc.org/en/master/index.html) extension. It enhances the interactivity of your Sphinx-generated documentation by enabling you to explore Sphinx-Needs-Data generated by the [Sphinx-Needs-Extension](https://www.sphinx-needs.com). +The `sphinx_needs_data_explorer` is a web application written in HTML, CSS, and JavaScript, provided as a [Sphinx](https://www.sphinx-doc.org/en/master/index.html) extension. It enhances the interactivity of your Sphinx-generated documentation by enabling you to explore Sphinx-Needs-Data generated by the [Sphinx-Needs-Extension](https://www.sphinx-needs.com). ## Goals and Realization
-![](doc/source/images/sphinx_needs_data_explorer.svg) +![](https://raw.githubusercontent.com/mi-parkes/sphinx-needs-data-explorer/6d9afc22473bdcf64cf12f92188f1c4203ce3ae5/doc/source/images/sphinx_needs_data_explorer.svg)
@@ -30,7 +30,7 @@ You can choose **network layout** - hierarchical right-to-left - hierarchical with repulsion -![](doc/source/images/network-perspective.jpg) +![](https://raw.githubusercontent.com/mi-parkes/sphinx-needs-data-explorer/6d9afc22473bdcf64cf12f92188f1c4203ce3ae5/doc/source/images/network-perspective.jpg)
@@ -38,55 +38,55 @@ You can choose **network layout** In Table-View-Perspective you can see sphinx-needs data in table. You can select which columns should be visible and which hidden. -![](doc/source/images/table-perspective.jpg) +![](https://raw.githubusercontent.com/mi-parkes/sphinx-needs-data-explorer/6d9afc22473bdcf64cf12f92188f1c4203ce3ae5/doc/source/images/table-perspective.jpg)
#### `File-View` In File-View-Perspective, you can see a list of files in which Sphinx-needs data were found. -![](doc/source/images/file-perspective.jpg) +![](https://raw.githubusercontent.com/mi-parkes/sphinx-needs-data-explorer/6d9afc22473bdcf64cf12f92188f1c4203ce3ae5/doc/source/images/file-perspective.jpg)
### Powerfull Interactive Data Filtering You can predefine filtering expressions during documentation generation or interactively while browsing documentation, and apply the data filtering across all three view perspectives. -![](doc/source/images/data-filtering.jpg) +![](https://raw.githubusercontent.com/mi-parkes/sphinx-needs-data-explorer/6d9afc22473bdcf64cf12f92188f1c4203ce3ae5/doc/source/images/data-filtering.jpg) You can use attribute lookup table while writing your filters. -![](doc/source/images/scr6.jpg) +![](https://raw.githubusercontent.com/mi-parkes/sphinx-needs-data-explorer/6d9afc22473bdcf64cf12f92188f1c4203ce3ae5/doc/source/images/scr6.jpg)
### Exploring In-Neighbours, Out-Neighbours or both -![](doc/source/images/sh2.jpg) +![](https://raw.githubusercontent.com/mi-parkes/sphinx-needs-data-explorer/6d9afc22473bdcf64cf12f92188f1c4203ce3ae5/doc/source/images/sh2.jpg)
### Visualizing Constraint Violations in Network Transitions -![](doc/source/images/scr7.jpg) +![](https://raw.githubusercontent.com/mi-parkes/sphinx-needs-data-explorer/6d9afc22473bdcf64cf12f92188f1c4203ce3ae5/doc/source/images/scr7.jpg)
### Controlling Neighborhood Depth in Network Visualization -![](doc/source/images/depthview.gif) +![](https://raw.githubusercontent.com/mi-parkes/sphinx-needs-data-explorer/6d9afc22473bdcf64cf12f92188f1c4203ce3ae5/doc/source/images/depthview.gif)
### Switching between Perspective Views and Documentation -![](doc/source/images/sh3.jpg) +![](https://raw.githubusercontent.com/mi-parkes/sphinx-needs-data-explorer/6d9afc22473bdcf64cf12f92188f1c4203ce3ae5/doc/source/images/sh3.jpg)
### Interaction -![](doc/source/images/sphinx-needs-data-explorer.gif) +![](https://raw.githubusercontent.com/mi-parkes/sphinx-needs-data-explorer/6d9afc22473bdcf64cf12f92188f1c4203ce3ae5/doc/source/images/sphinx-needs-data-explorer.gif)
@@ -100,12 +100,12 @@ Alternatively (Linux) git clone https://github.com/mi-parkes/sphinx-needs-data-explorer.git cd sphinx-needs-data-explorer - - python3 -m venv .venv - source .venv/bin/activate - pip install -r doc/requirements.txt - - python3 -m build --wheel + + poetry install + poetry build + poetry run task doc + + # you can then install the package in your virtual environment pip install dist/sphinx_needs_data_explorer*.whl ## Activation @@ -136,7 +136,7 @@ or you can include it only if the extension is available in your virtual environ If your project uses [sphinx_book_theme](https://github.com/executablebooks/sphinx-book-theme), `sphinx_needs_data_explorer` supports full integration in your documentation by adding `E` header button accesible from any documentation page. -![](doc/source/images/E-header-button-doc.jpg) +![](https://raw.githubusercontent.com/mi-parkes/sphinx-needs-data-explorer/6d9afc22473bdcf64cf12f92188f1c4203ce3ae5/doc/source/images/E-header-button-doc.jpg) Otherwise, you can create hyperlink to `sphinx_needs_data_explorer` by adding the following role in your .rst file(s) @@ -164,8 +164,7 @@ You can predefine filtering expressions to populate the filter drop-down list: `sphinx_needs_data_explorer` Help lists all attributes found in your project that can be used for data filtering. -![](doc/source/images/help1.jpg) - +![](https://raw.githubusercontent.com/mi-parkes/sphinx-needs-data-explorer/6d9afc22473bdcf64cf12f92188f1c4203ce3ae5/doc/source/images/help1.jpg) Visualizing Constraint Violations in Network Transitions: diff --git a/README_pypi.md b/README_pypi.md deleted file mode 100644 index c51fc70..0000000 --- a/README_pypi.md +++ /dev/null @@ -1,187 +0,0 @@ -## About - -
- -The `sphinx_needs_data_explorer` is a web application written in HTML, CSS, and JavaScript, provided as a [Sphinx](https://www.sphinx-doc.org/en/master/index.html) extension. It enhances the interactivity of your Sphinx-generated documentation by enabling you to explore Sphinx-Needs-Data generated by the [Sphinx-Needs-Extension](https://www.sphinx-needs.com). - -## Goals and Realization - -
- -![](https://mi-parkes.github.io/sphinx-needs-data-explorer/_images/sphinx_needs_data_explorer.svg) - -
- -## Features - -### Three Sphinx-Needs Data View Perspectives - -#### `Network-View` -In Network-View-Perspective you can see how sphinx-needs data are interconnected in data networks. - -You can choose which **data context** to see -- incoming connections from in-neighbours -- outgoing connections from out-neighbours -- incoming and outgoing connections - -You can choose **network layout** -- hierarchical bottom-up -- hierarchical right-to-left -- hierarchical with repulsion - -![](https://mi-parkes.github.io/sphinx-needs-data-explorer/_images/network-perspective.jpg) - -
- -#### `Table-View` -In Table-View-Perspective you can see sphinx-needs data in table. You can select which columns should -be visible and which hidden. - -![](https://mi-parkes.github.io/sphinx-needs-data-explorer/_images/table-perspective.jpg) - -
- -#### `File-View` -In File-View-Perspective, you can see a list of files in which Sphinx-needs data were found. - -![](https://mi-parkes.github.io/sphinx-needs-data-explorer/_images/file-perspective.jpg) - -
- -### Powerfull Interactive Data Filtering -You can predefine filtering expressions during documentation generation or interactively while browsing documentation, and apply the data filtering across all three view perspectives. - -![](https://mi-parkes.github.io/sphinx-needs-data-explorer/_images/data-filtering.jpg) - - -
- -You can use attribute lookup table while writing your filters. - -![](https://mi-parkes.github.io/sphinx-needs-data-explorer/_images/scr6.jpg) - -
- -### Exploring In-Neighbours, Out-Neighbours or both - -![](https://mi-parkes.github.io/sphinx-needs-data-explorer/_images/sh2.jpg) - -
- -### Visualizing Constraint Violations in Network Transitions - -![](https://mi-parkes.github.io/sphinx-needs-data-explorer/_images/scr7.jpg) - -
- -### Controlling Neighborhood Depth in Network Visualization - -![](https://mi-parkes.github.io/sphinx-needs-data-explorer/_images/depthview.gif) - -
- -### Switching between Perspective Views and Documentation - -![](https://mi-parkes.github.io/sphinx-needs-data-explorer/_images/sh3.jpg) - -
- -### Interaction - -![](https://mi-parkes.github.io/sphinx-needs-data-explorer/_images/sphinx-needs-data-explorer.gif) - -
- -## Installation - -You can install the package with pip - - pip install sphinx-needs-data-explorer - -Alternatively (Linux) - - git clone https://github.com/mi-parkes/sphinx-needs-data-explorer.git - cd sphinx-needs-data-explorer - - python3 -m venv .venv - source .venv/bin/activate - pip install -r doc/requirements.txt - - python3 -m build --wheel - pip install dist/sphinx_needs_data_explorer*.whl - -## Activation - -In your conf.py configuration file, add `sphinx_needs_data_explorer` to your extensions list. And, please, make sure that `sphinx_needs` extension is configured to generate needs.json file in the root of your documentation E.g.: - - extensions = [ - ... - 'sphinx_needs_data_explorer' - ... - ] - ... - needs_build_json = True - -or you can include it only if the extension is available in your virtual environment: - - ... - try: - import sphinx-needs-data-explorer - extensions.add('sphinx-needs-data-explorer') - except ImportError: - pass - ... - needs_build_json = True - -
- -If your project uses [sphinx_book_theme](https://github.com/executablebooks/sphinx-book-theme), -`sphinx_needs_data_explorer` supports full integration in your documentation by adding `E` header button accesible from any documentation page. - -![](https://mi-parkes.github.io/sphinx-needs-data-explorer/_images/E-header-button-doc.jpg) - -Otherwise, you can create hyperlink to `sphinx_needs_data_explorer` by adding the following role in your .rst file(s) - - :sphinx_needs_data_explorer:`Sphinx Needs Data Explorer Test` - -## Configuration - -If defined, the following parameters are used for configuration: - -* [needs_extra_options](https://sphinx-needs.readthedocs.io/en/latest/configuration.html#needs-extra-options) - the parameter defines extra sphinx-needs options -* [needs_extra_links](https://sphinx-needs.readthedocs.io/en/latest/configuration.html#needs-extra-links) - the parameter defines the type links to use when extracting sphinx-needs linkage -* [needs_types](https://sphinx-needs.readthedocs.io/en/latest/configuration.html#needs-types) - the parameter defines sphinx-needs types and their attributes like node colors - -You can predefine filtering expressions to populate the filter drop-down list: - - sphinx_needs_data_explorer_config = { - "filters":[ - "status=='open'", - "['15','16'] in id", - "title ~ /r.*[0-9]+5'$/i", - "type != 'req' && incoming==[]", - "type=='spec' && outgoing!=[] && title ~ /5'$/" - ] - } - -`sphinx_needs_data_explorer` Help lists all attributes found in your project that can be used for data filtering. - -![](https://mi-parkes.github.io/sphinx-needs-data-explorer/_images/help1.jpg) - -Visualizing Constraint Violations in Network Transitions: - - sphinx_needs_data_explorer_config = { - "valid-linkage-color":"Black", - "invalid-linkage-color":"OrangeRed", - "valid-linkage":{ - 'need': { - 'need':'refinement' - }, - 'feat': { - 'feat':'refinement', - 'need':'links' - }, - ... - } - } - diff --git a/doc/requirements.txt b/doc/requirements.txt deleted file mode 100644 index 39ba475..0000000 --- a/doc/requirements.txt +++ /dev/null @@ -1,7 +0,0 @@ -Sphinx===6.1.3 -sphinx-book-theme==1.0.1 -sphinxcontrib-plantuml==0.24 -sphinx-needs==2.0.0 -sphinx-copybutton==0.5.2 -build==1.0.3 -myst_parser==2.0.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index a00eb0c..f8ec1ee 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,4 +1,4 @@ -import os, sys +import os, re, sys from sphinx.util.console import bold, colorize from sphinx.util import logging from sphinx.errors import ExtensionError @@ -109,14 +109,14 @@ def copy_and_modify_readme_md(app, docname, source): ofilename = os.path.join(app.srcdir, "_README.txt") with open(ifilename, encoding="utf-8") as thefile: content = thefile.read() - replacedText = content.replace( - """![](doc/source/images/sphinx_needs_data_explorer.svg)""", - """```{raw} html - -```""", - ) - - replacedText = replacedText.replace("doc/source/images", "images") + replacedText = re.sub(r'\!\[\]\(.*/doc/source/images/sphinx_needs_data_explorer.svg\)', + """```{raw} html + +```""",content) + + # article = re.sub(r'(?is).+', '', article) + # replacedText = replacedText.replace("doc/source/images", "images") + replacedText = re.sub(r'^.*doc/source/images','images',replacedText) # This needs to be redesigned!!! if replacedText != content: print(f"Creating {colorize('darkgreen',ofilename)}") diff --git a/doc/source/demo.rst b/doc/source/demo.rst index 17861b0..500948f 100644 --- a/doc/source/demo.rst +++ b/doc/source/demo.rst @@ -1,3 +1,5 @@ +:orphan: + DEMO ==== .. feat:: Title of 'F00001' diff --git a/doc/source/dummy.rst b/doc/source/dummy.rst new file mode 100644 index 0000000..4e6eebd --- /dev/null +++ b/doc/source/dummy.rst @@ -0,0 +1,7 @@ +.. + This is a heck to force including sphinx_needs_data_explorer.svg in + generated documentation + +:orphan: + +.. image:: images/sphinx_needs_data_explorer.svg diff --git a/doc/source/index.rst b/doc/source/index.rst index c6f898e..d1d877c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -4,10 +4,6 @@ Sphinx Needs Data Explorer .. include:: _README.txt :parser: myst_parser.sphinx_ -.. - .. include:: readme_link.md - :parser: myst_parser.sphinx_ - Test it in Action ----------------- :doc:`Demo Sphinx Project ` diff --git a/pyproject.toml b/pyproject.toml index 91cdc49..16ef25c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -40,8 +40,12 @@ requires = ["poetry-core"] build-backend = "poetry.core.masonry.api" [tool.taskipy.tasks] -doc = "cd doc && sphinx-build -M html source build" -black = "poetry run -vvv black ." +help = { cmd = "task --list", help="Show this help" } +doc = { cmd = "cd doc && sphinx-build -M html source build", help = "Generate the package documentation using Sphinx." } +black = { cmd = "poetry run -vvv black .", help = "Apply the Black code formatter to the package's source tree." } +clean = { cmd = "rm -rf build dist doc/build", help = "Remove all intermediate and output files." } +clean-doc = { cmd = "rm -rf doc/build" , help = "Remove all intermediate and output documentation files."} +set-readme-refs = { cmd = "sed -i 's/6d9afc22473bdcf64cf12f92188f1c4203ce3ae5/6d9afc22473bdcf64cf12f92188f1c4203ce3ae5/g' README.md" } [tool.black] line-length = 88 diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 41aa05c..0000000 --- a/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -poetry -pre-commit>=3.0.0 diff --git a/setup.py b/setup.py deleted file mode 100644 index c4f2514..0000000 --- a/setup.py +++ /dev/null @@ -1,43 +0,0 @@ -from setuptools import setup, find_packages - -with open("README_pypi.md", "r", encoding="utf-8") as f: - long_description = f.read() - -setup( - name="sphinx-needs-data-explorer", - version="0.8.9", - packages=find_packages(), - author="Michael Parkes", - author_email="mparkes@post.cz", - description="Sphinx-needs-data-explorer is a Sphinx extension to visualize Sphinx-Needs data", - url="https://github.com/mi-parkes/sphinx-needs-data-explorer", - license="MIT License", - package_data={ - "sphinx_needs_data_explorer": [ - "_static/_static/js/explorer_button.js", - "_static/_templates/article-header-buttons.html", - "_static/_templates/explorer-button.html", - "_static/sphinx_needs_data_explorer.css", - "_static/sphinx_needs_data_explorer.js", - "_static/sphinx_needs_data_explorer.html", - "_static/jquery/jquery-3.7.1.min", - "_static/jquery/LICENSE.txt", - "_static/peg/LICENSE.txt", - "_static/peg/peg-0.10.0.min.js", - "_static/select2/select2.min.js", - "_static/select2/LICENSE.md", - "_static/select2/select2.min.css", - "_static/select2/package.json", - "_static/vis-network/vis-network.min.js", - "_static/vis-network/vis-network.min.js.map", - "_static/vis-network/LICENSE-APACHE-2.0", - "_static/vis-network/package.json", - "_static/vis-network/LICENSE-MIT", - ] - }, - include_package_data=True, - python_requires=">=3.10", - install_requires=["Sphinx>=5.3.0"], - long_description=long_description, - long_description_content_type="text/markdown", -) diff --git a/uid_entrypoint b/uid_entrypoint index 3052cb6..4cca1ad 100755 --- a/uid_entrypoint +++ b/uid_entrypoint @@ -3,18 +3,6 @@ if [ "$VERBOSE" == "true" ]; then echo "Current shell path:$SHELL" set -x fi -if [ ! -d myvenv ]; then - python3 -m venv myvenv - source myvenv/bin/activate - if [ -f requirements.txt ]; then - pip install -r requirements.txt - else - ls -l /tmp/requirements.txt - pip install -r /tmp/requirements.txt - fi - python -m pip install --upgrade pip -else - source myvenv/bin/activate -fi +poetry install pwd exec /usr/bin/bash