Add barebones user documentation #2
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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).
Created using pip-compile on the new `docs` extra in pyproject.toml.
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.
Both in the CI pipeline and the release job.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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).
Add mkdocs.yml, documentation requirements file
Created using pip-compile on the new
docsextra in pyproject.toml.