Skip to content

WIP: Adding Getting Started section to docs - #99

Open
dotsdl wants to merge 3 commits into
masterfrom
docs-tutorials
Open

WIP: Adding Getting Started section to docs#99
dotsdl wants to merge 3 commits into
masterfrom
docs-tutorials

Conversation

@dotsdl

@dotsdl dotsdl commented Feb 17, 2020

Copy link
Copy Markdown
Member

This PR adds a Getting Started section to the alchemlyb docs. It moves the installation instructions under this heading, and creates new Tutorials and Examples pages under this heading as well.

To give the existing package documentation a clear entry point to relay high-level package details, this PR also adds an Overview of the alchemlyb library page. This is referenced by the Tutorials page.

The following are required to close this PR.

  • Completed Pandas Basics tutorial
  • Completed 10 Minutes to alchemlyb tutorial
  • Completed Overview of the alchemlyb library package documentation page

Screenshot from 2020-02-17 15-12-30

@codecov

codecov Bot commented Feb 17, 2020

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.26%. Comparing base (7fcdf7a) to head (8b4e44f).
⚠️ Report is 229 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #99   +/-   ##
=======================================
  Coverage   97.26%   97.26%           
=======================================
  Files          12       12           
  Lines         695      695           
  Branches      141      141           
=======================================
  Hits          676      676           
  Misses          5        5           
  Partials       14       14           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dotsdl dotsdl mentioned this pull request Mar 11, 2020
4 tasks
@orbeckst orbeckst added the docs label Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants