Project

Profile

Help

Task #2682

Updated by bmbouter over 2 years ago

This should be roughly a two paragraph task which will add a section on Docs to the plugin writer's guide.

Explain that plugin writers can host their docs however they want, but some popular options are hosting on docs.pulpproject.org, readthedocs.org, on github pages, or via readme files in the plugin's repo on github.

Explain that to host on docs.pulpproject.org your docs must meet the minimum requirements which is that your docs can be built by Sphinx with <code>git clone <your repo>;cd <your repo>/docs; make clean; make html</code>. The plugin template should already provide this.

To enroll a plugin's docs on docs.pulpproject.org send an email request to the pulp-dev mailing list with the repo details.

in the http://pad-katello.rhcloud.com/p/pulp3_doc_structure

Back