8000 add req_docs to publish doc workflow by tuix · Pull Request #138 · vikinganalytics/mvg · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

add req_docs to publish doc workflow #138

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

Merged
merged 4 commits into from
Feb 2, 2022
Merged

add req_docs to publish doc workflow #138

merged 4 commits into from
Feb 2, 2022

Conversation

tuix
Copy link
Contributor
@tuix tuix commented Jan 31, 2022

Description

Publish docs workflow fails because it is not installing dependencies in requirements_docs.txt see https://github.com/vikinganalytics/mvg/actions/runs/1775390719

New dependencies: (Added to requirements_*.txt)

Fixes # (potential issues that are fixed by this PR)

Type of Change

  • Bug fix (non-breaking change which fixes an issue -> bump patch)
  • New feature (non-breaking change which adds functionality -> bump minor version)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected -> bump major version)
  • Documentation Update

Checklist

  • I have added tests that prove that my fix/feature works
  • Linters pass locally and I have followed PEP8 code style
  • New and existing tests pass locally
  • I have updated the documentation if needed
  • I have commented hard-to-understand areas in the code

Requirements

  • I have updated the MVG version

@tuix tuix assigned vnadhan and unassigned vnadhan Jan 31, 2022
@tuix tuix requested a review from vnadhan January 31, 2022 23:17
@vnadhan
Copy link
Contributor
vnadhan commented Feb 1, 2022

@tuix Is the requirements_dev required for this pipeline?

@vnadhan
Copy link
Contributor
vnadhan commented Feb 1, 2022

Upon building the docs locally, there seems to be a problem in the README.md file at the beginning.
image

it is probably due to the tab space in README.md
image

Copy link
Contributor
@vnadhan vnadhan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Remove tab space in front of the <img> tag
    image

@tuix
Copy link
Contributor Author
tuix commented Feb 1, 2022
  • Remove tab space in front of the <img> tag
    image

@vnadhan if it is causing unnecessary complications, feel free to remove those badges.

@vnadhan
Copy link
Contributor
vnadhan commented Feb 1, 2022
  • Remove tab space in front of the <img> tag
    image

@vnadhan if it is causing unnecessary complications, feel free to remove those badges.

No issues showing the badges. the tab space causes a problem. I will commit a fix

@vnadhan vnadhan self-requested a review February 2, 2022 08:30
Copy link
Contributor
@vnadhan vnadhan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good now!

8000
@tuix tuix merged commit 03bbd82 into master Feb 2, 2022
@tuix tuix deleted the add-reqs-docs branch February 2, 2022 16:56
SergioMDCB pushed a commit that referenced this pull request Feb 9, 2022
* add req_docs to publish doc workflow

* Remove tabspace that caused a malfunction in sphinx docs

* m2r2 module used for documentation is moved to requirements_docs

* Docs pipeline does not need modules from requirements_dev

Co-authored-by: Vishnu Nadhan <nadhan.vishnu@gmail.com>
SergioMDCB added a commit that referenced this pull request Feb 14, 2022
* adding label propgation figure and updatinf kpidemo figure

* Label propagation feature description

* Update of labelPropagation documentation

* Final version of the label propagation notebook documentation

* Adding md file and figure for label propagation documentation

* add req_docs to publish doc workflow (#138)

* add req_docs to publish doc workflow

* Remove tabspace that caused a malfunction in sphinx docs

* m2r2 module used for documentation is moved to requirements_docs

* Docs pipeline does not need modules from requirements_dev

Co-authored-by: Vishnu Nadhan <nadhan.vishnu@gmail.com>

* bump mvg version (#139)

* Update mvg version

* adding label propgation figure and updatinf kpidemo figure

* Label propagation feature description

* Update of labelPropagation documentation

* Final version of the label propagation notebook documentation

* Adding md file and figure for label propagation documentation

* Update mvg version

* Fixing black typo

* Fixing the plotting error on analysis_classes for labelpropagation

* Fixing lynting issues

* Fixing lynting issue

* Update the version of mvg

* Adding feature description into index file

* fix qutotation around feature name

* Updating label_propagation feature description to fix typos and update version

* Updating text in notebook to avoid misunderstandings

Co-authored-by: Mohsen Nosratinia <mohsen.nosratinia@vikinganalytics.se>
Co-authored-by: Vishnu Nadhan <nadhan.vishnu@gmail.com>
tuix added a commit that referenced this pull request Feb 17, 2022
* adding label propgation figure and updatinf kpidemo figure

* Label propagation feature description

* Update of labelPropagation documentation

* Final version of the label propagation notebook documentation

* Adding md file and figure for label propagation documentation

* add req_docs to publish doc workflow (#138)

* add req_docs to publish doc workflow

* Remove tabspace that caused a malfunction in sphinx docs

* m2r2 module used for documentation is moved to requirements_docs

* Docs pipeline does not need modules from requirements_dev

Co-authored-by: Vishnu Nadhan <nadhan.vishnu@gmail.com>

* bump mvg version (#139)

* Update mvg version

* adding label propgation figure and updatinf kpidemo figure

* Label propagation feature description

* Update of labelPropagation documentation

* Final version of the label propagation notebook documentation

* Adding md file and figure for label propagation documentation

* Update mvg version

* Fixing black typo

* Fixing the plotting error on analysis_classes for labelpropagation

* Fixing lynting issues

* Fixing lynting issue

* Update the version of mvg

* Adding feature description into index file

* fix qutotation around feature name

* Updating label_propagation feature description to fix typos and update version

* Updating text in notebook to avoid misunderstandings

Co-authored-by: Mohsen Nosratinia <mohsen.nosratinia@vikinganalytics.se>
Co-authored-by: Vishnu Nadhan <nadhan.vishnu@gmail.com>
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
0