docs: update documentation to include new web docstrings.

This commit is contained in:
upstreamdata
2024-04-19 21:41:17 -06:00
parent 8e81e18622
commit b6ec6caa72
13 changed files with 111 additions and 9 deletions

View File

@@ -22,13 +22,16 @@ Welcome to `pyasic`! `pyasic` uses an asynchronous method of communicating with
## Installation
It is recommended to install `pyasic` in a [virtual environment](https://realpython.com/python-virtual-environments-a-primer/#what-other-popular-options-exist-aside-from-venv) to isolate it from the rest of your system. Options include:
- [venv](https://docs.python.org/3/library/venv.html): included in Python standard library but has fewer features than other options
- [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv): [pyenv](https://github.com/pyenv/pyenv) plugin for managing virtualenvs
```
```
pyenv install <python version number>
pyenv virtualenv <python version number> <env name>
pyenv activate <env name>
```
```
- [conda](https://docs.conda.io/en/latest/)
##### Installing `pyasic`