Sphinx Setup

There are 2 steps to setup gitbook support, step 1 is to generate html files, step 2 is to config the path.

A demo will be appear at end.

Generate HTML

First make sure the build html is generated.

Open Terminal, enter the Sphinx document source files directory, run the following command:

make html

then open user config file marboo_config.json and find the following content:

"comment": "For GitBook/Sphinx/VimWiki Source Files",
"url_mappings": [{
    "path":"",
    "server": ""
}],

add a url mapping as following:

{
    "path": "Sphinx Path",
    "server": "Sphinx"
}

if it does not work, add replace_with to config the build html path:

{
    "path": "<Sphinx Document Source Files Directory>",
    "replace_with": "<Sphinx Document Build HTML Path>",
    "server": "Sphinx"
}

json key introduction:

• path Sphinx Document Source Files Directory, the Marboo Home Directory can be missed.
• replace_with Sphinx Generated HTML Files Directory, the Marboo Home Directory can be missed.
• server Document Type，it's always Sphinx

Demo

Open user config file marboo_config.json and add the following content:

"url_mappings": [
    {
        "path": "/CC-Books/zh-sphinx-doc",
        "server": "Sphinx"
    }
],