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

display "latest" in doc version #1726

Merged
merged 2 commits into from
Jul 16, 2021

Conversation

epassaro
Copy link
Member

Description

Motivation and context

As @jaladh-singhal pointed out, looks more "stable". The documentation pipeline builds the master branch tip, so it's a good name. Also it's the same used by RTD.

How has this been tested?

  • Testing pipeline.
  • Other.

Built locally.

Examples

Type of change

  • Bug fix.
  • New feature.
  • Breaking change.
  • None of the above.

Checklist

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
    • (optional) I have built the documentation on my fork following the instructions.
  • I have assigned and requested two reviewers for this pull request.

@tardis-bot
Copy link
Contributor

Before a pull request is accepted, it must meet the following criteria:

  • Is the necessary information provided?
  • Is this a duplicate PR?
    • If a new PR is clearly a duplicate, ask how this PR is different from the original PR?
    • If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue.
  • Does it pass existing tests and are new tests provided if required?
    • The test coverage should not decrease, and for new features should be close to 100%.
  • Is the code tidy?
    • No unnecessary print lines or code comments.

2 similar comments
@tardis-bot
Copy link
Contributor

Before a pull request is accepted, it must meet the following criteria:

  • Is the necessary information provided?
  • Is this a duplicate PR?
    • If a new PR is clearly a duplicate, ask how this PR is different from the original PR?
    • If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue.
  • Does it pass existing tests and are new tests provided if required?
    • The test coverage should not decrease, and for new features should be close to 100%.
  • Is the code tidy?
    • No unnecessary print lines or code comments.

@tardis-bot
Copy link
Contributor

Before a pull request is accepted, it must meet the following criteria:

  • Is the necessary information provided?
  • Is this a duplicate PR?
    • If a new PR is clearly a duplicate, ask how this PR is different from the original PR?
    • If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue.
  • Does it pass existing tests and are new tests provided if required?
    • The test coverage should not decrease, and for new features should be close to 100%.
  • Is the code tidy?
    • No unnecessary print lines or code comments.

@codecov
Copy link

codecov bot commented Jul 15, 2021

Codecov Report

Merging #1726 (5338d64) into master (ab967fd) will not change coverage.
The diff coverage is n/a.

❗ Current head 5338d64 differs from pull request most recent head b5e18b4. Consider uploading reports for the commit b5e18b4 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1726   +/-   ##
=======================================
  Coverage   61.87%   61.87%           
=======================================
  Files          63       63           
  Lines        5852     5852           
=======================================
  Hits         3621     3621           
  Misses       2231     2231           
Impacted Files Coverage Δ
tardis/tardis/montecarlo/spectrum.py 65.51% <0.00%> (ø)
tardis/tardis/plasma/standard_plasmas.py 73.11% <0.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ab967fd...b5e18b4. Read the comment docs.

Copy link
Member

@jaladh-singhal jaladh-singhal left a comment

Choose a reason for hiding this comment

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

Thanks for making quick PR. There's one thing we should take care of

docs/conf.py Outdated Show resolved Hide resolved
@epassaro epassaro force-pushed the simple-version-docs branch from 4043e8a to b5e18b4 Compare July 15, 2021 19:50
@epassaro
Copy link
Member Author

Thanks for making quick PR. There's one thing we should take care of

Done!

@epassaro epassaro requested a review from jaladh-singhal July 15, 2021 19:51
@jaladh-singhal jaladh-singhal merged commit a60344e into tardis-sn:master Jul 16, 2021
DhruvSondhi pushed a commit to DhruvSondhi/tardis that referenced this pull request Aug 1, 2021
* display "latest" in doc version

* fix html title
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
* display "latest" in doc version

* fix html title
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants