Uploaded image for project: 'RHEL'
  1. RHEL
  2. RHEL-17924

Update reference to sphinx in upstream wiki

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done-Errata
    • Icon: Undefined Undefined
    • None
    • None
    • sos
    • None
    • None
    • Minor
    • sst_cee_supportability
    • None
    • False
    • Hide

      None

      Show
      None
    • None
    • None
    • None

      Currently, the docs in sos and the upstream wiki mention the following about creating the docs:

       

      ## Documentation 
User and API [documentation][6] is automatically generated using [Sphinx][7] and [Read the Docs][8]. 
To generate HTML documents locally, install dependencies using 
``` pip install -r requirements.txt ``` 
and run 
``` python3 setup.py build_sphinx -a ```

      This approach doesn't work anymore, since build_sphinx as a command was removed in commit ac17ca4f460b67f438f3bef7b4eacc2c133a7643 

      [build] Convert to setuptools

            rhn-support-jcastillo Jose Castillo
            rhn-support-jcastillo Jose Castillo
            Jose Castillo Jose Castillo
            Adriana Jurkechova Adriana Jurkechova
            Votes:
            0 Vote for this issue
            Watchers:
            9 Start watching this issue

              Created:
              Updated:
              Resolved: