Skip to content

Conversation

bdewilde
Copy link
Collaborator

@bdewilde bdewilde commented Aug 29, 2020

Description

  • drops unmaintained m2r in favor of recommonmark, and updates sphinx version
  • replaces rst-formatted narrative documentation with md-formatted equivalents
  • adds auto-generated summary tables to many sections of the API Reference docs, to help users get an overview of functionality and find what they're looking for
  • removes manual section references in favor of auto-generated references
  • fixes and improves some docstrings throughout the code

Motivation and Context

Docs have always been a weak point; this PR takes a couple steps in the right direction.

How Has This Been Tested?

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation, and I have updated it accordingly.

@bdewilde bdewilde changed the base branch from master to develop August 29, 2020 16:48
@bdewilde bdewilde merged commit f790e89 into develop Aug 29, 2020
@bdewilde bdewilde deleted the migrate-docs-to-markdown branch August 29, 2020 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant