Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-22957

Update Documenteer packaging

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: documenteer
    • Labels:
      None

      Description

      Maintenance of the project package for the 0.6 release of Documenteer. Goals:

      • Use PEP 518 - ready packing methods (pyproject.toml, setup.cfg, setup.py)
      • Update the presentation of the documentation
      • More comprehensive user documentation (document existing extensions, scripts, and features).

        Attachments

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-23095 Remove pytest-runner from Documenteer 0.5.x

          • Done

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            jsick Jonathan Sick added a comment -
            • PEP 518-ify the build process by adding a pyproject.toml file.
            • Removed the deprecated pytest-runner plugin.
            • Moved most of the packaging configuration to setup.cfg.
            • Documentation improvements:
            • Added a new Developer guide and Release procedure guide.
            • Added an installation page.
            • Moved the Python API reference to its own page.
            • Improved the README to list features.
            • Document configuration modules
            • Document all scripts
            • Document all Sphinx extensions
            • Added GitHub community health features: contributing, support, and code of conduct files.
            Show
            jsick Jonathan Sick added a comment - PEP 518-ify the build process by adding a pyproject.toml file. Removed the deprecated pytest-runner plugin. Moved most of the packaging configuration to setup.cfg. Documentation improvements: Added a new Developer guide and Release procedure guide. Added an installation page. Moved the Python API reference to its own page. Improved the README to list features. Document configuration modules Document all scripts Document all Sphinx extensions Added GitHub community health features: contributing, support, and code of conduct files.
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            This will be released with documenteer 0.6

            Show
            jsick Jonathan Sick added a comment - This will be released with documenteer 0.6

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Watchers:
              Jonathan Sick
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.