[SDK][Fuel Plugins] SDK lacks instructions on how to use Sphinx to build up plugin-related documentation

Bug #1518939 reported by Irina Povolotskaya on 2015-11-23
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Fuel for OpenStack
High
Evgeny Konstantinov
7.0.x
High
Irina Povolotskaya
8.0.x
Medium
Irina Povolotskaya
Future
Undecided
Irina Povolotskaya
Mitaka
High
Evgeny Konstantinov

Bug Description

SDK should have the following issues in place to assist developers in using Sphinx for docs:
- Sphinx introduction (how it simplifies the doc preparation process)
- Sample for Sphinx-related config files (what are these)
- Links to the plugin repos that use sphinx so far

Changed in fuel:
status: New → In Progress

Published here: https://wiki.openstack.org/wiki/Fuel/Plugins#Documentation_files_structure_and_Sphinx_usage
to be added: samples for specific doc configuration, link to the official Sphinx website+mans

Changed in fuel:
milestone: 7.0-updates → 9.0
status: In Progress → New
Changed in fuel:
status: New → Confirmed

(This check performed automatically)
Please, make sure that bug description contains the following sections filled in with the appropriate data related to the bug you are describing:

actual result

version

expected result

steps to reproduce

For more detailed information on the contents of each of the listed sections see https://wiki.openstack.org/wiki/Fuel/How_to_contribute#Here_is_how_you_file_a_bug

tags: added: need-info
Changed in fuel:
assignee: Irina Povolotskaya (ipovolotskaya) → Evgeny Konstantinov (evkonstantinov)
tags: removed: need-info
Changed in fuel:
milestone: 9.0 → 10.0
tags: added: non-release
Changed in fuel:
status: Confirmed → Won't Fix
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers