How to simulate the documentation

[felipemarkson]

This project uses MkDocs for documentation with the following extensions:

• Material for MkDocs;
• mkdocstrings;
• mkdocs-jupyter;

To simulate the documentation make sure that all these packages are installed.

You can easily get all the development environment using Poetry.

$ git clone https://github.com/felipemarkson/dssdata.git
$ cd dssdata
$ poetry install
$ poetry shell

The file requiriments.txt does not have the development packages.

After installing all packages, you can run:

$ mkdocs serve

By default, the documentation is built in http://127.0.0.1:8000 on a development server.

You can edit any file from /docs or/and edit the functions docstrings in python files.