Project

General

Profile

Support #24366

Produce API documentation using sphinx

Added by Marco Mambelli 4 months ago. Updated 3 months ago.

Status:
Resolved
Priority:
Normal
Category:
-
Target version:
Start date:
04/30/2020
Due date:
% Done:

0%

Estimated time:
Stakeholders:
Duration:

Description

Automate the writing of the API documentation via sphinx using the docstrings

Publish an example on the website

Publish the process in the wiki

History

#1 Updated by Marco Mambelli 4 months ago

  • Status changed from New to Resolved

Completed, changes are in master.
It is using sphinx and tox

v3.6.2 is on the web: https://glideinwms.fnal.gov/api.prd/index.html
And there is a log file with warnings from malformed docstrings (we have many):
https://glideinwms.fnal.gov/api.prd/sphinx_build_warnings.txt

Instructions are in the wiki:
  • Build the API documentation and copy it to the Web area (Optional for RC)
    # E.g. From the source directory:
    tox
    pushd doc/api
    tar -czf gwms-api-doc.tgz html
    scp gwms-api-doc.tgz fnalu.fnal.gov:
    # From fnalu.fnal.gov
    cd /web/sites/glideinwms.fnal.gov/htdocs
    tar xzf ~/gwms-api-doc.tgz 
    mv html api.vX_Y_Z
    

#2 Updated by Marco Mambelli 3 months ago

  • Status changed from Resolved to Closed

#3 Updated by Marco Mambelli 3 months ago

  • Status changed from Closed to Resolved


Also available in: Atom PDF