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

Documentations deployment fix #136

Merged
merged 4 commits into from
Apr 1, 2022
Merged

Documentations deployment fix #136

merged 4 commits into from
Apr 1, 2022

Conversation

fedem-p
Copy link
Member

@fedem-p fedem-p commented Mar 31, 2022

The documentation deployment action wasn't working due to an update in the jupyter_books package

PR changes:

  1. updated toc.yml file to work with the updated version of jupyter_books
  2. changed name of the github actions
  3. limited the run of lint/tests/package deployment to push on master and PRs
  4. changed location of the docs requirements -> merged with requirements_dev.txt

Comment on lines -3 to +22
on: push
on:
push:
branches:
- master
pull_request:
types:
- assigned
- unassigned
- labeled
- unlabeled
- opened
- edited
- reopened
- synchronize
- ready_for_review
- locked
- unlocked
- review_requested
- review_request_
workflow_dispatch:
Copy link
Member Author

Choose a reason for hiding this comment

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

fix 3

Comment on lines +10 to +15

jupyter-book
jupytext
sphinx_autodoc_typehints
furo
recommonmark
Copy link
Member Author

Choose a reason for hiding this comment

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

fix 4

Comment on lines -1 to -20
- file: index

- part: Overview
format: jb-book
root: index
parts:
- caption: Overview
chapters:
- file: timeline

- part: Configuration
- file: timeline
- caption: Configuration
chapters:
- file: configuration/installation
- file: configuration/configuration

- part: Development
- file: configuration/installation
- file: configuration/configuration
- caption: Development
chapters:
- file: development/code_organization

- part: Hardware
- file: development/code_organization
- caption: Hardware
chapters:
- file: hardware/hardware

- part: Api
Copy link
Member Author

Choose a reason for hiding this comment

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

fix 1

name: 🚀 page_deploy
name: 🚀 Deploy Documentation
Copy link
Member Author

Choose a reason for hiding this comment

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

fix 2

@fedem-p fedem-p self-assigned this Mar 31, 2022
@fedem-p fedem-p added bug Something isn't working documentation Improvements or additions to documentation labels Mar 31, 2022
@fedem-p fedem-p requested a review from vigji March 31, 2022 13:31
@coveralls
Copy link

coveralls commented Mar 31, 2022

Pull Request Test Coverage Report for Build 2071522598

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 79.957%

Totals Coverage Status
Change from base Build 2071125477: 0.0%
Covered Lines: 2242
Relevant Lines: 2804

💛 - Coveralls

@diegoasua diegoasua self-requested a review March 31, 2022 14:03
@fedem-p fedem-p merged commit 95732a0 into master Apr 1, 2022
@fedem-p fedem-p deleted the deploy_fix branch April 1, 2022 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants