Skip to content

Conversation

JR-1991
Copy link
Member

@JR-1991 JR-1991 commented Apr 12, 2024

Important

This PR is still a draft and work in progress

Overview

This PR introduces the mkdocs-material to pyDataverse, which serves as a modern substitution for ReadTheDocs. It looks better and provides more functionality to the docs itself. Plus, mkdocs can be easily integrated into GitHub Pages, removing the third-party dependency of ReadTheDocs (although surely possible, if wanted). This PR also implements an automatic generation of the API reference based on the given docstrings.

TLDR

  • Migrate docs to mkdocs-material
  • Add API reference generation based on docstrings

How can I take a look at the new docs?

To check the current state of the docs, please run the following commands:

python -m pip install mkdocs-material
mkdocs serve

You should be presented with a localhost link to paste into your browser.

image

@JR-1991 JR-1991 added the pkg:docs Documentation related activities label Apr 12, 2024
@JR-1991 JR-1991 self-assigned this Apr 12, 2024
@JR-1991 JR-1991 added this to the 0.4.0 milestone Apr 12, 2024
@JR-1991 JR-1991 mentioned this pull request May 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg:docs Documentation related activities
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

1 participant