sphinxnotes-mock

Sphinx extension for hiding unsupported directives and roles without modifying documents.

• Documentation: https://sphinx.silverrainz.me/mock

• Source: https://github.com/sphinx-notes/mock

• Changelog: https://sphinx.silverrainz.me/mock/changelog.html

• Tracker: https://github.com/sphinx-notes/mock/issues

• Download: https://pypi.org/project/sphinxnotes-mock/#files

Introduction

The extension creates mock directives and roles based on Configuration, for hiding unsupported directives and roles without modifying documents.

Note

For now, only directive is supported

It is especially useful when a certain directive/role is provided by an incompatible extension, or the directive/roles is incompatible with your current buidler or theme.

You can quickly learn how to use this extension from Getting Started.

Contents

Contents

• Getting Started
• Installation
  • Install from Source
• Usage
  • Mock directives
  • Mock Mode
• Configuration
• Change Log
  • 2022-08-14 1.0.0
  • 2022-02-01 1.0.0a0

The Sphinx Notes Project

This project is a developed by Shengyu Zhang, as part of The Sphinx Notes Project.

The Sphinx Notes Project

• Home
• Blog
• PyPI