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

Luis/docs #94

Merged
merged 117 commits into from
Nov 11, 2021
Merged

Luis/docs #94

merged 117 commits into from
Nov 11, 2021

Conversation

LDiazN
Copy link
Collaborator

@LDiazN LDiazN commented Oct 28, 2021

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 friendly

Relevant files

  • docs - This entire folder contains the files required by mkdocs to build the website, including some documentation pages
  • src/microscope/manager.py - Changes to the API so it's easier to use
  • .github/worflows/ - Folder with new worflows for the publishing github actions

Further work

  • Create more pages, specially relevant:
    • Creating a Crawler
    • Creating a Scraper
    • c4v as a CLI tool

Copy link
Member

@Edilmo Edilmo left a 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.

@Edilmo
Copy link
Member

Edilmo commented Oct 30, 2021

Please check if the PR #54
should be used (and merge) before this one, or if this PR already cover the content there in which case we could archive it.

@LDiazN LDiazN merged commit 1aa1c5b into master Nov 11, 2021
LDiazN pushed a commit that referenced this pull request Nov 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants