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.

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 barebones user documentation #2

Merged
merged 7 commits into from
Jan 17, 2024
Merged

Add barebones user documentation #2

merged 7 commits into from
Jan 17, 2024

Commits on Jan 17, 2024

  1. Add barebones user documentation 

    Adds an mkdocs build with the verbatim setup and section layout from our
lakefs-spec project. The content and all unnecessary notebook-related
dependencies were dropped.

The mkdocs.yml and pip-compile requirements file are added in a
subsequent commit.

Adds back the GitHub Action related to mike-docs, since mike is a
comfortable solution for doing a latest vs. stable split for two
concurrent documentation editions (master vs. release).
    @nicholasjng
    nicholasjng committed Jan 17, 2024
    Configuration menu
    Copy the full SHA
    4161b0a View commit details
    Browse the repository at this point in the history

  2. Add mkdocs.yml, documentation requirements file 

    Created using pip-compile on the new `docs` extra in pyproject.toml.
    @nicholasjng
    nicholasjng committed Jan 17, 2024
    Configuration menu
    Copy the full SHA
    bc870b3 View commit details
    Browse the repository at this point in the history

  3. Fix pydoclint errors in docstrings

    @nicholasjng
    nicholasjng committed Jan 17, 2024
    Configuration menu
    Copy the full SHA
    2513e9d View commit details
    Browse the repository at this point in the history

  4. Rename default branch to main

    @nicholasjng
    nicholasjng committed Jan 17, 2024
    Configuration menu
    Copy the full SHA
    921bbc7 View commit details
    Browse the repository at this point in the history

  5. Rename project to nnbench 

    Reasons are that mlbench is already taken both on PyPI and GitHub Pages,
ironically by different projects respectively.

nnbench is both short and still conveys its main purpose well enough.
    @nicholasjng
    nicholasjng committed Jan 17, 2024
    Configuration menu
    Copy the full SHA
    c450c29 View commit details
    Browse the repository at this point in the history

  6. Reorganize mike action

    @nicholasjng
    nicholasjng committed Jan 17, 2024
    Configuration menu
    Copy the full SHA
    7a9bcf3 View commit details
    Browse the repository at this point in the history

  7. Add missing venv setup step to docs jobs 

    Both in the CI pipeline and the release job.
    @nicholasjng
    nicholasjng committed Jan 17, 2024
    Configuration menu
    Copy the full SHA
    cc55b32 View commit details
    Browse the repository at this point in the history