You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You should see that the homepage of the documentation site is the same as the repository README file.
255
-
Importantly, the documentation website inclides the [_application programming interface_ (API](https://en.wikipedia.org/wiki/API) reference documentation.
255
+
Importantly, the documentation website includes the [_application programming interface_ (API](https://en.wikipedia.org/wiki/API) reference documentation.
256
256
The API documentation is generated from [docstrings](https://peps.python.org/pep-0257/#what-is-a-docstring) in the source code.
257
257
258
258
## 🐍 Setting up a virtual environment for project
@@ -283,7 +283,7 @@ or on Windows:
283
283
.venv\Scripts\activate
284
284
```
285
285
286
-
So activate your environment and you should see braces `( )` with your project slug on the left of your terminal window.
286
+
Activate your environment, and you should see braces `( )` with your project slug on the left of your terminal window.
287
287
This might be slightly different depending on your terminal setup.
288
288
289
289
Once you have activated the environment you can use the following command to install any packages within the `.venv` environment
@@ -379,7 +379,7 @@ It's sometimes useful to be able to render the HTML documentation pages locally.
379
379
For example if you're editing docstrings or adding additional pages, and you want to check everything worked.
380
380
The package is set up to use [MkDocs](https://www.mkdocs.org/) to build the documentation website.
381
381
The API documentation is generated using the [`mkdocstrings` plug-in](https://mkdocstrings.github.io/).
382
-
Mkdocks and `mkdocstrings` will have been installed in your local development environment, because you installed the package with the `docs` dependencies.
382
+
MkDocs and `mkdocstrings` will have been installed in your local development environment, because you installed the package with the `docs` dependencies.
0 commit comments