Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Clean and update the documentation of the sphinx directive.

See original GitHub issue

@choldgraf made many good comments about the documentation of the sphinx directing in ipython/ipython#11402

Cleaning the documentation, and moving most of the basic content into the module docstring, and include it with .. automodule would be good, then passing through the file and fixing the english/pharasing, plus reducing the size of the page woudl be good.

Leavin that as an “easy” issue for anyone willing to contribute.

Issue Analytics

State:
Created 5 years ago
Comments:8 (7 by maintainers)

Top GitHub Comments

1reaction

choldgrafcommented, Oct 18, 2018

go @LucianaMarques !!! 🎉

0reactions

willingccommented, Oct 28, 2018

@Carreau @LucianaMarques Now that the PR is merged, I’m going to close this. Thanks!

Top Results From Across the Web

Always regenerate Sphinx documents containing a specific ...

The documentation I am working on relies on the possibility to collect and reformat information from other pages with the help of directives...

Populating our documentation - Sphinx-RTD-Tutorial

Running the above command will process any Sphinx source files contained within the simpleble-master/docs/source (i.e. our Sphinx source ) ...

Directives - Sphinx documentation

As previously discussed, a directive is a generic block of explicit markup. While Docutils provides a number of directives, Sphinx provides many more...

Auto-Documenting a Python Project Using Sphinx

1. Install Sphinx · 2. Initialize the Sphinx Configuration · 3. Update the conf.py File · 4. Auto-generate the rst Files · 5....

SphinxTutorial Documentation - Read the Docs

We begin by creating a Sphinx documentation root directory: ... A pair of :param: and :type: directive options must be used for each ......