Skip to content
GitLab
  • Menu
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
    • Switch to GitLab Next
  • Sign in / Register
  • extensions extensions
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 76
    • Issues 76
    • List
    • Boards
    • Service Desk
    • Milestones
    • Requirements
  • Merge requests 13
    • Merge requests 13
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Code review
    • Insights
    • Issue
    • Repository
  • Wiki
    • Wiki
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • InkscapeInkscape
  • extensionsextensions
  • Merge requests
  • !310

Restore and modernize documentation

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Jonathan Neuhauser requested to merge joneuhauser/extensions:restore-documentation into master May 18, 2021
  • Overview 0
  • Commits 7
  • Pipelines 1
  • Changes 8

I inadvertedly broke the documentation by adding the cssselect module. Sorry for that.

This gave me the opportunity to overhaul the look of the documentation, it now has the familiar style of ReadTheDocs, which is IMO much easier to read than the default sphinx style.

It now looks like this: https://joneuhauser.gitlab.io/-/extensions/-/jobs/1274341705/artifacts/build/sphinx/html/index.html

It seems like Numpy/Google-tyle docstrings are more often used than rst docstrings. Therefore the extension "napoleon" was loaded. We should definitely proofread these generated pages though. Note that I haven't gotten type linking to work with "napoleon" yet, so it might make sense to homogenize the docstrings into sphinx format.

A stub landing page has been added as well, so it's clear how additional documentation can be added.

I suggest pinging the author of https://gitlab.com/binyamin/inkscape-extensions-guide whether his work can be transferred to the project repository.

Edited May 18, 2021 by Jonathan Neuhauser
Assignee
Assign to
Reviewer
Request review from
Time tracking
Source branch: restore-documentation