Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean Up of Existing Documentation #66

Merged
merged 15 commits into from
Nov 4, 2022
Merged

Clean Up of Existing Documentation #66

merged 15 commits into from
Nov 4, 2022

Conversation

axkoenig
Copy link
Contributor

Description

While preparing my PR on adding new documentation for the Huggingface, Hub and Torchvision drivers, I came across a couple of problems in the existing documentation which this PR fixes.

Main problems

  • some python code in the docs was not rendered because of missing new lines
  • some tables were not rendered because of wrong formatting
  • there was a bad copy/paste error in the adult dataset docs (was copied from allanAI and showed up as a duplicate)
  • Redundant naming of "dataset cards" was visually confusing
  • the index.rst did not correctly apply "captions" to the datasets, hence no headings on the left sidebar
  • all tables that show attributes and values of the dataset had no heading
  • datasets were not sorted alphabetically, which was confusing

Fixes # issue

Type of change

  • 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 not work as expected)
  • Documentation update
  • Refactoring including code style reformatting
  • Other (please describe):

Checklist:

  • I have read the contributing guideline doc (external contributors only)
  • Lint and unit tests pass locally with my changes
  • I have kept the PR small so that it can be easily reviewed
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • All dependency changes have been reflected in the pip requirement files

Some Screenshots of Current Version

Screen Shot 2022-10-31 at 11 59 10
Screen Shot 2022-10-31 at 11 59 58
Screen Shot 2022-10-31 at 12 00 16

Copy link
Contributor

@winfried-ripken winfried-ripken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks Alex! 👍


Contribute
------------------
dataset_links/*
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice one!

@axkoenig axkoenig merged commit bb6b499 into main Nov 4, 2022
@axkoenig axkoenig deleted the ak-improve-driver-docs branch November 4, 2022 09:19
@github-actions github-actions bot locked and limited conversation to collaborators Nov 4, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants