Skip to content

Commit

Permalink
Fix some docs formatting issues
Browse files Browse the repository at this point in the history
  • Loading branch information
ml-evs committed Aug 20, 2024
1 parent 4f43ccb commit 1e154e8
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 12 deletions.
23 changes: 13 additions & 10 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ instance, in which case please check out the separate Python API package at
[datalab-org/datalab-api](https://github.com/datalab-org/datalab-python-api).

The instructions below outline how to make a development installation on your local machine.
We strongly recommend following the [deployment instructions](deployment.md) on [docs.datalab-org.io](docs.datalab-org.io/en/stable/deployment/) if you are deploying for use in production.
We strongly recommend following the [deployment instructions](deployment.md) on [docs.datalab-org.io](https://docs.datalab-org.io/en/stable/deployment/) if you are deploying for use in production.
These instructions are also useful for developers who want to use Docker to create a reproducible development environment.

This repository consists of two components:
Expand All @@ -35,7 +35,7 @@ This requires a MongoDB server to be running on your desired host machine.

1. Install the free MongoDB community edition (full instructions on the [MongoDB website](https://docs.mongodb.com/manual/installation/)).
* For Mac users, MongoDB is available via [HomeBrew](https://github.com/mongodb/homebrew-brew).
- You can alternatively run the MongoDB via Docker using the config in this package with `docker compose up database` (see further instructions [below](#deployment-with-docker).
- You can alternatively run the MongoDB via Docker using the config in this package with `docker compose up database` (see [deployment instructions](deploy.md).
* If you wish to view the database directly, MongoDB has several GUIs, e.g. [MongoDB Compass](https://www.mongodb.com/products/compass) or [Studio 3T](https://robomongo.org/).
- For persistence, you will need to set up MongoDB to run as a service on your computer (or run manually each time you run the `pydatalab` server).

Expand All @@ -59,23 +59,25 @@ standard library Python `venv` module.
environment.
2. Activate the virtual environment (optional for `uv`) and install dependencies. One can either use the loosely pinned dependencies in `pyproject.toml`, or the locked versions in the `requirements/requirements-all-dev.txt` and `requirements/requirements-all.txt` files.

=== "`uv`"
=== "Installation with `uv`"

```shell
# EITHER: Install all dependencies with locked versions
# EITHER: Install all dependencies with locked versions, then install the local package
uv pip install -r requirements/requirements-all-dev.txt
uv pip install -e '.[all,dev]'
# OR: Install all dependencies with loosely pinned versions
uv pip install -e '.[all]'
uv pip install -e '.[all,dev]'
```

=== "`venv`"
=== "Installation with `venv`"

```shell
source .venv/bin/activate
# EITHER: Install all dependencies with locked versions
# EITHER: Install all dependencies with locked versions, then install the local package
pip install -r requirements/requirements-all-dev.txt
pip install -e '.[all, dev]'
# OR: Install all dependencies with loosely pinned versions
pip install -e '.[all]'
pip install -e '.[all, dev]'
```

##### Using `pipenv` (DEPRECATED)
Expand All @@ -98,14 +100,15 @@ To make use of this file:

1. Run the server from the `pydatalab` folder with either:

=== "`uv` or `venv`
=== "Launching with `uv` or `venv`"

```shell
cd pydatalab
source .venv/bin/activate
flask --app 'pydatalab:main.create_app()' --reload run
```

=== "`pipenv`"
=== "Launching with `pipenv`"

```shell
cd pydatalab
Expand Down
3 changes: 2 additions & 1 deletion pydatalab/docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ This document describes the different options for configuring a *datalab*
instance.
It is primarily intended for those who are *deploying* *datalab* on persistent
hardware, but may also be useful for developers.
Deployment instructions can be found under [](deployment.md).
Deployment instructions can be found under ["Deploying datalab and server
administration"](deployment.md).

*datalab* has 3 main configuration sources.

Expand Down
6 changes: 5 additions & 1 deletion pydatalab/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ theme:
features:
- content.code.copy

features:
- content.tabs.link

repo_name: datalab-org/datalab
repo_url: https://github.com/datalab-org/datalab

Expand All @@ -54,7 +57,8 @@ markdown_extensions:
format: !!python/name:pymdownx.superfences.fence_code_format

- pymdownx.inlinehilite
- pymdownx.tabbed
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist
- pymdownx.snippets
- toc:
Expand Down

0 comments on commit 1e154e8

Please sign in to comment.