GLAREAN-Doku/mkdocs-library
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
Tools to set up multiple MkDocs sites with one main book and multiple sub-books. Used to create larger sets of documentation, e.g. a library with multiple packages.
39 commits 1 branch 0 tags 801 KiB
Find a file
Exact
Urs Liska cf9fb6dbbb Add config data to pip installation (test) 
This is a test to add the non-Python config data to the installation
through pip. According to
https://stackoverflow.com/questions/1612733/including-non-python-files-with-setup-py
This should work, but I can only test this after pushing ...
2020-03-25 09:43:00 +01:00
documentation Create a package that can be used with pip3 2020-03-11 18:08:22 +01:00
mkdocs_library Create a package that can be used with pip3 2020-03-11 18:08:22 +01:00
.gitignore ignore "site/" for generated documentation 2020-02-22 09:39:06 +01:00
LICENSE Initial commit 2020-02-03 12:50:08 +01:00
MANIFEST.in Add config data to pip installation (test) 2020-03-25 09:43:00 +01:00
README.md Update README, also reflecting name change 2020-02-08 17:59:32 +01:00
setup.py Add config data to pip installation (test) 2020-03-25 09:43:00 +01:00

README.md

mkdocs-library

This tool makes it possible to combine/merge a number of sites generated with MkDocs into a single multi-document site, or library. The aim of this is to have multiple interdependent books with mostly identical configurations, which can be configured through templates to have slightly different properties

There are basically two use cases: creating large sites with one additional conceptual navigation layer, or to create a library of interdependent books, for example documenting multiple packages within a library. In this case the sub-books may be maintained in separate repositories with independent access permissions.

The project and each subbook are configured with several configuration files, which also provide the nice side-effect of separating the site configuration from the navigation structure. There are several strategies of incorporating the sibling books in the navigational structure of the site, which is particularly useful in combination with the tabs feature of the Material theme.

The script provides a number of tasks that can be combined through command line "recipes":

  • merge-sources (combine the templates)
  • build (ask MkDocs to build the books)
  • merge-indexes (combine the search indexes generated by MkDocs)
  • deploy (call a custom script provided by the project.

These are just the initial commits, documentation will follow ...