Skip to content

Restore rich Sphinx contributing doc, link from GitHub-Markdown doc #392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mfisher87 merged 1 commit into from
Jan 27, 2025
Merged

Restore rich Sphinx contributing doc, link from GitHub-Markdown doc #392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 1 addition & 125 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,125 +1 @@
# Contributing

## Development Install

> **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.

### 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
```

### 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

# 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

```bash
pip uninstall jupytergis
```

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

- **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](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.
Please check out [our documentation's contributing guide](https://jupytergis.readthedocs.io/en/latest/contributing.html).
Copy link
Member

@arjxn-py arjxn-py Jan 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @mfisher87, I'm happy with this, keeping in mind that we've #251 open which will allow both - rich Sphinx and contributing doc rendered on github too hopefully.
I'd be happy to know what @brichet thinks about the same before we go forward :)

Copy link
Member Author

@mfisher87 mfisher87 Jan 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even with MyST, I don't know that we can achieve rich online docs that are also available in rich format on GitHub either with includes or with symlinks just because of path issues 😭 For example:

.
├── CONTRIBUTING.md
└── docs
    ├── contributing.md
    ├── thing2.md
    └── thing.md

CONTRIBUTING.md would need to link to thing2.md like [link](/docs/thing2.md), but docs/contributing.md would link to the same document with [link](/thing2.md). It's an implicit behavior we'd have to always keep in mind; in other repos where I saw this, contributors kept making mistakes with links because they weren't aware of these tradeoffs with the document was being included from outside the documentation dorectory.

Also, GitHub won't support any Sphinx plugins we use to add special directives like tabs that give the documentation a more logical flow!

153 changes: 151 additions & 2 deletions docs/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,151 @@
.. include:: ../CONTRIBUTING.md
:parser: myst_parser.sphinx_
============
Contributing
============

Development install
-------------------

.. 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.


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 <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.
Loading