[SDK][Fuel Plugins] SDK lacks instructions on how to use Sphinx to build up plugin-related documentation
Bug #1518939 reported by
Irina Povolotskaya
This bug affects 1 person
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Fuel for OpenStack |
Won't Fix
|
High
|
Evgeny Konstantinov | ||
7.0.x |
In Progress
|
High
|
Irina Povolotskaya | ||
8.0.x |
Confirmed
|
Medium
|
Irina Povolotskaya | ||
Future |
New
|
Undecided
|
Irina Povolotskaya | ||
Mitaka |
Confirmed
|
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 |
Changed in fuel: | |
milestone: | 7.0-updates → 9.0 |
status: | In Progress → New |
Changed in fuel: | |
status: | New → Confirmed |
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.
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