Uploaded image for project: 'Acumos'
  1. Acumos
  2. ACUMOS-1177

Convert Docs Project Structure to facilitate faster docs builds

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Open
    • Priority: Medium
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: documentation
    • Labels:
      None

      Description

      Follow up with LF's Thanh Ha on changing docs project structure to eliminate submodules. This new structure will increase docs build times.

      Amount of effort is unknown.

      The Docs project structure changes - we have to use intersphinx linking (see OpenDaylight and      https://docs.releng.linuxfoundation.org/en/latest/project-documentation.html)

      Then each component must be updated - the docs folder must have conf.py etc added to it.

      Also we cannot change the RST gate job to fail on warning if all the docs are compiling with every job.

        Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

            Assignee:
            Unassigned
            Reporter:
            aimeeu Aimee Ukasick
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Due:
              Created:
              Updated: