Home

Introduction

Welcome to the python-sphinx-cli-help wiki!

This project is a template for creating a command line interface for a Sphinx project.

Once a Sphinx project is built, the objects.inv file contains a list of all the objects in the project.

This project converts the objects.inv created by Sphinx Docs into a command line interface that allows for quick searching and launching the online help from the command line.

This project is designed as a template. Using this template for your own project means that you can create and publish CLI package for any Sphinx project with very little configuration and No coding necessary.

Getting Started

Create your own project by click the Use this template on GitHub.

Configure your project.

Import data.

Build your project.

Search using the CLI.