https://github.com/investin-pro/investin_docs

Investin documentation
https://github.com/investin-pro/investin_docs

Last synced: 7 days ago
JSON representation

Investin documentation

• Host: GitHub
• URL: https://github.com/investin-pro/investin_docs
• Owner: Investin-pro
• Created: 2021-03-04T22:50:37.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-09-22T12:08:54.000Z (over 2 years ago)
• Last Synced: 2023-03-08T22:01:15.751Z (almost 2 years ago)
• Language: HTML
• Homepage: https://investin-pro.github.io/Investin_docs/
• Size: 5.57 MB
• Stars: 1
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Investin documentation

====================

Investin's documentation is build using [MkDocs](https://www.mkdocs.org/) and the beautiful [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme.

In order to create Investin's documentation you have to install them:

```

pip install mkdocs mkdocs-material

```

Be sure that your installed version of `Markdown>=3.0.1`.

Then generate `api.md` from source (from the `src` directory):

```

python code_doc_autogen.py

```

Test it (from the `src` directory):

```

mkdocs serve

```

Finally build the static website (from the `src` directory):

```

mkdocs build

```

It will create the static website in `$Investin/docs/`.