MkDocs packages

Collection of MkDocs packages we use to build our documentation.

Introduction

We use MkDocs to make documentation of our projects and in this repo we are collecting all packages internally developed to fit some particular needs.

The packages are divided in two folders mkdocs-plugins and mkdocs-themes, respectively for MkDocs plugins and MkDocs themes (actually we have just one theme :D).

You will find below some useful information on how to build and publish your own plugin or your own theme.

PyPi links to pakcages

Plugins

• mkdocs-izsam-search
• mkdocs-izsam-video

Theme

• mkdocs-bionformatic-izsam-theme

Create pip packages

Source: How to write your own Python Package and publish it on PyPi

Create a PyPi account

If you already have a PyPi account (and still remember your username/password, of course), you can skip this step. Otherwise, please go to PyPi homepage and register new account instantly.

Generate distribution archives and upload to PyPi

Generating distribution archives

These are archives that are uploaded to the Package Index and can be installed by pip. Make sure you have the latest versions of setuptools and wheel installed:

pip install --user --upgrade setuptools wheel

Now run this command from the same directory where setup.py is located:

python3 setup.py sdist bdist_wheel

Uploading the distribution archives

To do this, you can use twine. First, install it using pip:

pip install --user --upgrade twine

Then upload all the archives to PyPi:

python3 -m twine upload dist/*
... enter your PyPi username and password

Now everyone can install your package with familiar pip install command:

pip install {your_package_name}