-
Notifications
You must be signed in to change notification settings - Fork 3
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
Luis/docs #94
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
…problem with circular imports
…v to development pages
…kenizer properties to base model
…zer and load models without internet
Edilmo
approved these changes
Oct 30, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In general LGTM.
It was large though. If there are details I'm missing, let's handle in follow up small PRs.
Please check if the PR #54 |
LDiazN
pushed a commit
that referenced
this pull request
Nov 11, 2021
…nezuela/luis/docs Luis/docs 1aa1c5b
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.
Problem
We need a way to provide online documentation for both users and collaborators. It should easy to edit & update with the
CI
in order to reduce the amount of work to keep it up to date.Solution
We added mkdocs as a dependency to create our documents and added a few pages and the initial layout for the documentation.
You can preview the current documentation page here.
Also, we provided the proper configuration in the github CI to keep it up to date whenever there's a push to master.
Additional changes
Some refactors in the main object
microscope.Manager
to make it more user friendlyRelevant files
docs
- This entire folder contains the files required by mkdocs to build the website, including some documentation pagessrc/microscope/manager.py
- Changes to the API so it's easier to use.github/worflows/
- Folder with new worflows for the publishing github actionsFurther work