[docs] Create section for system tests in development documentation

Bug #1321682 reported by Nikolay Markov
26
This bug affects 4 people
Affects Status Importance Assigned to Milestone
Fuel for OpenStack
Fix Released
High
Alexandr Kostrikov

Bug Description

We need some auto-generated docs on system tests using Sphinx.

Tags: docs
Nikolay Markov (nmarkov)
Changed in fuel:
milestone: none → 5.1
importance: Undecided → Medium
Revision history for this message
Nikolay Markov (nmarkov) wrote :
Changed in fuel:
status: Confirmed → In Progress
Nikolay Markov (nmarkov)
Changed in fuel:
assignee: Nikolay Markov (nmarkov) → Aleksandra Fedorova (afedorova)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix merged to fuel-web (master)

Reviewed: https://review.openstack.org/95672
Committed: https://git.openstack.org/cgit/stackforge/fuel-web/commit/?id=9a12fd470ca111453b3ca3f1fe723e71396438fa
Submitter: Jenkins
Branch: master

commit 9a12fd470ca111453b3ca3f1fe723e71396438fa
Author: Nikolay Markov <email address hidden>
Date: Tue May 27 12:20:33 2014 +0400

    Environment variable check for system tests doc

    Related-Bug: #1321682

    Change-Id: Ib974d34d15fd94faa024eb760f0961c32572e9ca

Changed in fuel:
status: In Progress → Fix Committed
importance: Medium → High
status: Fix Committed → In Progress
Changed in fuel:
importance: High → Medium
milestone: 5.1 → 6.0
Revision history for this message
Dmitry Borodaenko (angdraug) wrote :

Is this still in progress?

Revision history for this message
Nastya Urlapova (aurlapova) wrote :

Aleksandra, please make a last effort with Nikolay and create a job or section in doc's job for building pydocs from tests.

Changed in fuel:
importance: Medium → High
tags: added: docs
Revision history for this message
Mike Scherbakov (mihgen) wrote :

Stalled in progress. Please ensure that bug reflects real status of the work.

Changed in fuel:
milestone: 6.0 → 6.1
status: In Progress → Confirmed
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to fuel-main (master)

Related fix proposed to branch: master
Review: https://review.openstack.org/150429

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to fuel-qa (master)

Related fix proposed to branch: master
Review: https://review.openstack.org/178604

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix merged to fuel-qa (master)

Reviewed: https://review.openstack.org/178604
Committed: https://git.openstack.org/cgit/stackforge/fuel-qa/commit/?id=e317c2d6d24ce283747f58d00ebfc31aaddf9188
Submitter: Jenkins
Branch: master

commit e317c2d6d24ce283747f58d00ebfc31aaddf9188
Author: Alexandr Kostrikov <email address hidden>
Date: Wed Apr 29 13:25:17 2015 +0300

    doc: Added an initial Sphinx documentation

    I have added a auto-generated documentation. It is done with
    Sphinx library. Sphinx uses reStructuredText as its markup language
    and docstrings as a source for automated documentation.

    According to https://www.python.org/dev/peps/pep-0257/
    I used a """ for quotes in docstrings and made
    """Docstring."""-looking one-liners and correct indentation
    for multiple-liners.
    Based on https://github.com/kennethreitz/requests
    I moved Makefile, requirements.txt and conf.py to /doc folder.
    Also I decided to make fuel-qa documentation
    similar to https://docs.python.org/2/tutorial/index.html
    with single table of contents.
    I have added empty __init__.py files to be able to produce
    documentation.
    I have added sys_test.log to .gitigonre because it has
    been generated at the documentation build.

    To make it faster and non-conflicting I added some banal
    class descriptions in order to get them in auto-generated documentation.
    I decided not to fight with warnings and poor docstring descriptions
    I added to make documentation less conflicting and for a faster review.
    Docstring improvements and detailed code description are left for later.
    For the same reasons I decied not to add docstrings to all methods.
    At a places where I made poor docstrings I have added a
    TODO documentation.

    Change-Id: I7701a9a3429abbf62b13ec5a31972298c0be5201
    Related-Bug: #1321682

Changed in fuel:
assignee: Aleksandra Fedorova (afedorova) → Fuel DevOps (fuel-devops)
Changed in fuel:
assignee: Fuel DevOps (fuel-devops) → Alexandr Kostrikov (akostrikov-mirantis)
Revision history for this message
Fuel Devops McRobotson (fuel-devops-robot) wrote : Related fix proposed to fuel-infra/jenkins-jobs (master)

Related fix proposed to branch: master
Change author: Alexandr Kostrikov <email address hidden>
Review: https://review.fuel-infra.org/7184

Revision history for this message
Fuel Devops McRobotson (fuel-devops-robot) wrote : Related fix merged to fuel-infra/jenkins-jobs (master)

Reviewed: https://review.fuel-infra.org/7184
Submitter: Aleksandra Fedorova <email address hidden>
Branch: master

Commit: e4bba4536dbc4cadb06a406b4b0b6786a140c336
Author: Alexandr Kostrikov <email address hidden>
Date: Fri May 29 14:18:06 2015

docs: Add jenkins job for fuel-qa docs.

This change adds inital support for fuel-qa
docs in common fuel documentation.
We still need more improvements to enable it
to appear in documetation like put this
docs on the web, link together with general
documentation.

Change-Id: Id3b045fb485c8c4e1ec1f245428a2174f1d4f12d
Related-Bug: #1321682

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on fuel-main (master)

Change abandoned by Igor Shishkin (<email address hidden>) on branch: master
Review: https://review.openstack.org/150429
Reason: This review is > 4 weeks without comment, and failed Jenkins the last time it was checked. We are abandoning this for now. Feel free to reactivate the review by pressing the restore button and leaving a 'recheck' comment to get fresh test results.

Changed in fuel:
status: Confirmed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.