From 858a02dc16ddf6504576f3a4a36c5e6a7aea9a77 Mon Sep 17 00:00:00 2001 From: Sorin Birchi Date: Sun, 25 Aug 2024 16:59:42 +0300 Subject: [PATCH] Modify publish.yaml Signed-off-by: Sorin Birchi --- .github/workflows/publish.yaml | 22 ++++++++++++++++--- docs_sphinx/conf.py | 1 + docs_sphinx/index.rst | 4 +--- docs_sphinx/modules.rst | 2 +- .../usage_comparison.rst} | 4 ++-- pyproject.toml | 2 +- 6 files changed, 25 insertions(+), 10 deletions(-) rename docs_sphinx/{usage comaprison/usage comparison.rst => usage_comparison/usage_comparison.rst} (99%) diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index 6bfe4b9..b02d2ed 100644 --- a/.github/workflows/publish.yaml +++ b/.github/workflows/publish.yaml @@ -7,17 +7,33 @@ on: pull_request: tags: - 'v*' + jobs: pypi-publish: name: upload release to PyPI runs-on: ubuntu-latest - # Specifying a GitHub environment is optional, but strongly encouraged environment: release permissions: - # IMPORTANT: this permission is mandatory for trusted publishing id-token: write steps: - # retrieve your distributions here + - name: Checkout code + uses: actions/checkout@v2 + + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: '3.x' + + - name: Install build dependencies + run: | + python -m pip install --upgrade pip + pip install build + + - name: Build package + run: python -m build + + - name: List dist directory contents + run: ls -la dist - name: Publish package distributions to PyPI uses: pypa/gh-action-pypi-publish@release/v1 \ No newline at end of file diff --git a/docs_sphinx/conf.py b/docs_sphinx/conf.py index 41a8f49..28bf4c3 100644 --- a/docs_sphinx/conf.py +++ b/docs_sphinx/conf.py @@ -31,6 +31,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + "sphinx_rtd_theme", ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs_sphinx/index.rst b/docs_sphinx/index.rst index 22c993e..6559a73 100644 --- a/docs_sphinx/index.rst +++ b/docs_sphinx/index.rst @@ -12,12 +12,10 @@ Welcome to QuantSI's documentation! user/units developer/units - usage/usage_comparison - + usage_comparison/usage_comparison modules - Indices and tables ================== diff --git a/docs_sphinx/modules.rst b/docs_sphinx/modules.rst index a7f5e8a..79de88a 100644 --- a/docs_sphinx/modules.rst +++ b/docs_sphinx/modules.rst @@ -1,4 +1,4 @@ -unitSI +QuantSI ====== .. toctree:: diff --git a/docs_sphinx/usage comaprison/usage comparison.rst b/docs_sphinx/usage_comparison/usage_comparison.rst similarity index 99% rename from docs_sphinx/usage comaprison/usage comparison.rst rename to docs_sphinx/usage_comparison/usage_comparison.rst index 34933c5..cd4e192 100644 --- a/docs_sphinx/usage comaprison/usage comparison.rst +++ b/docs_sphinx/usage_comparison/usage_comparison.rst @@ -1,5 +1,5 @@ -Usage -===== +Usage comparison +================ In this section, we will compare the usage of QuantSI with another packages. The comparation will be made with Pint and Astropy's units module. diff --git a/pyproject.toml b/pyproject.toml index 46fbc38..5c63d6a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -15,7 +15,7 @@ keywords = ['computational neuroscience', 'simulation', 'system units'] classifiers = [ 'Development Status :: 4 - Beta', 'Intended Audience :: Science/Research', - 'License :: GPL-3.0', + 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', 'Natural Language :: English', 'Operating System :: OS Independent', 'Programming Language :: Python',