1.0.1 • Published 4 years ago

docusaurus-plugin-sphinx-docs v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
4 years ago

Sphinx API Docs Integration Plugin for Docusaurus

Overview

Plugin to seemlesly integrate Sphinx API Docs into Docusaurus Website.

Here is how this plugin works: 1) (Optional) Generates Sphinx HTML site 2) Copies Sphinx's sources (HTML, JS, RST-files) over to the Docusaurus site 3) Updates the JavaScript references of the Sphinx's HTML sources with Docusaurus website's target

How to use

To

module.exports = {
  // ...
  plugins: ['@dmitryvinn/docusaurus-plugin-sphinx-docs'],
};

Note: Read more about Docusaurus plugins here.

Resources

The plugin is built based on scripts created by BoTorch team.