Metadata-Version: 2.0
Name: mkinx
Version: 0.1.3
Summary: Manage sphinx documentations with mkdocs
Home-page: http://github.com/vict0rsch
Author: Victor Schmidt
Author-email: vsch@protonmail.com
License: GNU
Description-Content-Type: UNKNOWN
Keywords: documentation doc sphinx mkdocs mkinx
Platform: UNKNOWN
Requires-Dist: watchdog
Requires-Dist: sphinx
Requires-Dist: mkdocs
Requires-Dist: sphinx-rtd-theme
Requires-Dist: numpy
Requires-Dist: pandas

About
=====

``mkinxs`` allows you to integrate several ``sphinx`` documentation
projects into one Home Documentation listing them and allowing you to
have cross projects documentation with ``mkdocs``.

Any ``sphinx`` module can be used as long as ``make html`` works and the
built code is in ``your_project/build``

Install
=======

``pip install mkinx``

Getting Started
===============

Start you Home Documentation with

::

    mkinx init your_project

Start the server with

::

    mkinx serve

Optionnaly you can specify a port with ``mkinx serve -s your_port``

Build the documentation with

::

    mkinx build [FLAGS]

Flags being:

::

      -v, --verbose                             verbose flag (Sphinx will stay verbose)
      -A, --all                                 Build doc for all projects
      -F, --force                               force the build, no verification asked
      -o, --only_index                          only build projects listed in the Documentation's Home
      -p, --projects [PROJECTS [PROJECTS ...]]  list of projects to build


