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.

Sign up for GitHub

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

Jump to bottom

Add docs to dataset template generator #76

Open

lgvaz opened this issue Oct 22, 2020 · 0 comments

Assignees

Labels

enhancement help wanted

Contributor

lgvaz commented Oct 22, 2020

🚀 Feature

Automatically create/update the necessary documentation files when using the generator.

autogen.py
Automate the readme creation, currently we have to copy each file individually:

    # Copy Birds README
    shutil.copyfile(icedata_dir / "icedata/datasets/birds/README.md", dest_dir / "birds.md")

    # Copy COCO README
    shutil.copyfile(icedata_dir / "icedata/datasets/coco/README.md", dest_dir / "coco.md")

mkdocs.yml
Update the Datasets section:

  - Datasets:
    - Birds: birds.md
    - COCO: coco.md

The text was updated successfully, but these errors were encountered:

lgvaz added enhancement help wanted labels

lgvaz self-assigned this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment