Skip to content

Commit

Permalink
Update README.md (#711)
Browse files Browse the repository at this point in the history
  • Loading branch information
amoghakancharla committed Nov 4, 2023
1 parent b5aa0e2 commit 2db4032
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

*Read this in other languages: [English](README.md), [Español](README.es-ES.md), [Português](README.pt-BR.md)*

Jupyter metapackage for installation and docs.
Jupyter metapackage for installation and documents

## Documentation structure

Expand All @@ -13,11 +13,11 @@ It is written in a combination of [reStructuredText](https://docutils.sourceforg

## Build the documentation locally

There are a few ways to build the documentation, see below for instructions:
There are a few ways to build the documentation; see below for instructions:

### Build the documentation automatically with `nox`

The easiest way to build the documentation locally is by using the [`nox` command line tool](https://nox.thea.codes/). This tool makes it easy to automate commands in a repository, and we have included a `docs` command to quickly install the dependencies and build the the documentation.
The easiest way to build the documentation locally is by using the [`nox` command line tool](https://nox.thea.codes/). This tool makes it easy to automate commands in a repository, and we have included a `docs` command to quickly install the dependencies and build the documentation.

To build and preview the site locally, follow these steps:

Expand Down Expand Up @@ -52,7 +52,7 @@ To start this live server, use the following `nox` command:
$ nox -s docs-live
```

When the build is finished, go to the URL that is displayed. It should show a live preview of your doucmentation.
When the build is finished, go to the URL that is displayed. It should show a live preview of your documentation.

To stop serving the website, press **`Ctrl`**-`C` in your terminal

Expand Down Expand Up @@ -99,8 +99,8 @@ then build the releases and publish them to PyPI.

The steps involved:

1. install tbump: `pip install tbump`
2. tag and publish the release `tbump $NEW_VERSION`.
1. Install tbump: `pip install tbump`
2. Tag and publish the release `tbump $NEW_VERSION`.

That's it!

Expand Down

0 comments on commit 2db4032

Please sign in to comment.