diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index a70311a1d..8f7dc5229 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -275,6 +275,7 @@ jobs: sphinx-tabs pydata-sphinx-theme sphinx-autodoc-typehints + myst-parser<4.0.0 - name: Download extension package uses: actions/download-artifact@v4 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 17f830cd3..e3dc8a543 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -37,4 +37,4 @@ repos: rev: v6.2.4 hooks: - id: rstcheck - args: ['--ignore-directives=tabs,toctree,autoclass,cssclass', '--report-level=warning'] + args: ['--ignore-directives=tabs,toctree,autoclass,cssclass,include', '--report-level=warning'] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b02e61488..e8bdd47b9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,53 +1,125 @@ -## Contributing +# Contributing -### Development install +## Development Install -**Note:** You will need [Node.js](https://nodejs.org/) to build the extension package. +> **Note** +> You will need [Node.js](https://nodejs.org/) to build the extension package. +> The `jlpm` command is JupyterLab's pinned version of [yarn](https://yarnpkg.com/) that is installed with JupyterLab. +> You may use [yarn](https://yarnpkg.com/) or [npm](https://www.npmjs.com/) in lieu of `jlpm` below. -The `jlpm` command is JupyterLab's pinned version of -[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use -`yarn` or `npm` in lieu of `jlpm` below. +### Clone the Source ```bash # Clone the repo to your local environment git clone https://github.com/geojupyter/jupytergis.git + # Change directory to the jupytergis directory cd jupytergis -# Install package in development mode +``` + +### Create a Virtual Environment + +#### Micromamba (Recommended) + +```bash +# Create a virtual environment +micromamba create --name jupytergis_dev -c conda-forge pip "nodejs<22" qgis + +# Activate it +micromamba activate jupytergis_dev +``` + +#### Plain Python + +> **Note** +> You may need to install some non-Python dependencies (e.g., QGIS, Node.js) separately when using this method. + +```bash +# Create a virtual environment +python -m venv .venv + +# Activate it +source .venv/bin/activate +``` + +### Install Dependencies and Build + +```bash +# Install packages in development mode. +# WARNING: This step may hang indefinitely due to a bug in Nx. See troubleshooting below. python scripts/dev-install.py + +# Rebuild extension Typescript source after making changes +jlpm run build +``` + +> **Note** +> By default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. +> To also generate source maps for the JupyterLab core extensions, you can run the following command: + +```bash +jupyter lab build --minimize=False ``` +### Watch for Changes and Rebuild + You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension. ```bash # Watch the source directory in one terminal, automatically rebuilding when needed jlpm run watch -# Alternatively, you can run the following after each TypeScript code change -jlpm run build:dev - # Run JupyterLab in another terminal jupyter lab ``` -With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt). +With the `watch` command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt). -By default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command: +> **Note** > `jlpm run watch` will sit and wait for a change once started. Edit a file to trigger a build. -```bash -jupyter lab build --minimize=False -``` - -### Development uninstall +## Development Uninstall ```bash pip uninstall jupytergis ``` -In development mode, you will also need to remove the symlink created by `jupyter labextension develop` -command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions` -folder is located. Then you can remove the symlink named `jupytergis` within that folder. +In development mode, you will also need to remove the symlink created by the `jupyter labextension develop` command. +To find its location, you can run `jupyter labextension list` to figure out where the `labextensions` folder is located. Then you can remove the symlink named `jupytergis` within that folder. + +## Code Quality + +We have several tools configured for checking code quality: + +- **Pre-commit checks** run automatically at commit time. + Install checks with: + + ```bash + pre-commit install + ``` + + Run them manually with: + + ```bash + pre-commit run --all-files + ``` + + - `Ruff` formats and lints (sometimes autofixes) Python code. + - Generic pre-commit checks help avoid common mistakes like committing large files or trailing whitespace. + +- **Package scripts** (defined in `package.json`) to check (and/or fix) TypeScript, JavaScript, CSS, JSON, Markdown, and YAML. + Run manually with: + + ```bash + jlpm run lint + ``` + + - `Prettier` formats the file types listed above. + - `Eslint` lints (sometimes autofixes) JS/TS code. + +## Troubleshooting -### Packaging the extension +- **Setup of development environment hangs indefinitely** when running the `dev-install.py` step, specifically on the Yarn linking step. -See [RELEASE](RELEASE.md) + - This may be caused by having a `.gitignore` file in your home directory. + This is a [known issue with Nx](https://github.com/nrwl/nx/issues/27494). + The [only known workaround](https://github.com/nrwl/nx/issues/27494#issuecomment-2481207598) is to remove the `.gitignore` file from your home directory or to work in a location outside of the home directory tree. diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 000000000..4afc7d3ff --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1,2 @@ +.. include:: ../CHANGELOG.md + :parser: myst_parser.sphinx_ diff --git a/docs/conf.py b/docs/conf.py index 8d52b40e4..f183ce9bb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,6 +17,7 @@ "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx_tabs.tabs", + "myst_parser", ] source_suffix = ".rst" diff --git a/docs/contributing.rst b/docs/contributing.rst index d382b5ce5..6889b7c46 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,151 +1,2 @@ -============ -Contributing -============ - -Development install -------------------- - -.. note:: - - You will need `Node.js `_ to build the extension package. - - The ``jlpm`` command is JupyterLab's pinned version of - `yarn `__ that is installed with JupyterLab. You may use - `yarn `__ or `npm `_ in lieu of ``jlpm`` below. - - -Clone the source -^^^^^^^^^^^^^^^^ - -.. code-block:: bash - - # Clone the repo to your local environment - git clone https://github.com/geojupyter/jupytergis.git - - # Change directory to the jupytergis directory - cd jupytergis - - -Create a virtual environment -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. tabs:: - - .. tab:: Micromamba (recommended) - - .. code-block:: bash - - # Create a virtual environment - micromamba create --name jupytergis_dev -c conda-forge pip "nodejs<22" qgis - - # Activate it - micromamba activate jupytergis_dev - - - .. tab:: Plain python - - .. note:: - - You may need to install some non-Python dependencies (e.g. QGIS, - Node.js) separately when using this method. - - - .. code-block:: bash - - # Create a virtual environment - python -m venv .venv - - # Activate it - source .venv/bin/activate - - -Install dependencies and build -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. code-block:: bash - - # Install packages in development mode. - # WARNING: This step may hang indefinitely due to a bug in Nx. See - # troubleshooting below. - python scripts/dev-install.py - - # Rebuild extension Typescript source after making changes - jlpm run build - - -.. note:: - - By default, the ``jlpm run build`` command generates the source maps for this extension to make it easier to debug using the browser dev tools. - To also generate source maps for the JupyterLab core extensions, you can run the following command: - - .. code-block:: bash - - jupyter lab build --minimize=False - - -Watch for changes and rebuild -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension. - -.. code-block:: bash - - # Watch the source directory in one terminal, automatically rebuilding when needed - jlpm run watch - - # Run JupyterLab in another terminal - jupyter lab - -With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt). - -.. note:: - - ``jlpm run watch`` will sit and wait for a change once started. Edit a file - to trigger a build. - - -Development uninstall ----------------------- - -.. code-block:: bash - - pip uninstall jupytergis - -In development mode, you will also need to remove the symlink created by ``jupyter labextension develop`` command. To find its location, you can run ``jupyter labextension list`` to figure out where the ``labextensions`` folder is located. Then you can remove the symlink named ``jupytergis`` within that folder. - - -Code quality ------------- - -We have several tools configured for checking code quality: - -* Pre-commit checks run automatically at commit time. - Install checks with ``pre-commit install``. - Run them manually with ``pre-commit run --all-files``. - **Will exit non-zero when finding errors or changing files.** - - * Ruff formats and lints (sometimes autofixes) Python code. - - * Generic pre-commit checks help avoid common mistakes like committing large - files or trailing whitespace. - -* Package scripts (defined in ``package.json``) to check (and/or fix) - TypeScript, JavaScript, CSS, JSON, Markdown, and YAML. - Run manually with ``jlpm run lint``. - **Will exit 0 when applying fixes. - Check the logs and/or ``git status`` after every run.** - - * Prettier formats the file types listed above. - - * Eslint lints (sometimes autofixes) JS/TS code. - - -Troubleshooting ---------------- - -* Setup of development environment hangs indefinitely when running the - ``dev-install.py`` step, specifically on the Yarn linking step. - - * This may be caused by having a ``.gitignore`` file in your home directory. - This is a `known issue with Nx `_. - The `only known workaround `_ is to remove the ``.gitignore`` file from your home directory or to work in a location outside of the home directory tree. +.. include:: ../CONTRIBUTING.md + :parser: myst_parser.sphinx_ diff --git a/docs/environment-docs.yml b/docs/environment-docs.yml index 9d084690f..a9d0fcc3b 100644 --- a/docs/environment-docs.yml +++ b/docs/environment-docs.yml @@ -16,3 +16,7 @@ dependencies: - sphinx-autodoc-typehints - xeus-python # TODO: Do we need this? + + # Install myst-parser via pip + - pip: + - myst-parser<4.0.0 diff --git a/docs/index.rst b/docs/index.rst index 855c04c33..49e233610 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -37,3 +37,4 @@ Table of contents python_api collab.rst contributing.rst + changelog.rst