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

[MRG] update documentation & add notebooks to docs #631

Merged
merged 25 commits into from
Mar 7, 2019
Merged

Conversation

ctb
Copy link
Contributor

@ctb ctb commented Jan 14, 2019

This reorganizes the documentation and adds Jupyter notebooks + binder links. See

for the major points of reorg.

Rendered notebooks are under the add-nbsphinx branch on readthedocs. Direct links:

both tutorials are also now updated to work, and to use bioconda:

Fixes #430 #552. See #628 for related discussions. Includes cleanup from #607.

TODO:

  • link these into the rest of the documentation :)
  • add binder integration so that from the documentation, you can directly click to execute notebooks
  • add relative links between notebooks so that once in binder, you don't have to start up an independent binder
  • before merge, check to make sure that we're pointing binder at the right branch (master, presumably)

Checklist:

  • Is it mergeable?
  • make test Did it pass the tests?
  • make coverage Is the new code covered?
  • Did it change the command-line interface? Only additions are allowed
    without a major version increment. Changing file formats also requires a
    major version number increment.
  • Was a spellchecker run on the source code and documentation after
    changes were made?

@codecov
Copy link

codecov bot commented Jan 14, 2019

Codecov Report

Merging #631 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #631   +/-   ##
=======================================
  Coverage   89.47%   89.47%           
=======================================
  Files          27       27           
  Lines        4238     4238           
  Branches       39       39           
=======================================
  Hits         3792     3792           
  Misses        446      446

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 c30b915...f69e6c8. Read the comment docs.

@ctb
Copy link
Contributor Author

ctb commented Jan 14, 2019

w00t the basic config seems to work! https://sourmash.readthedocs.io/en/add-nbsphinx/test-notebook.html

@ctb
Copy link
Contributor Author

ctb commented Feb 17, 2019

This is ready for initial commentary @luizirber @taylorreiter - thoughts very welcome!

@ctb ctb changed the title [WIP] add notebooks to readthedocs site [WIP] update documentation & add notebooks to docs Feb 23, 2019
@ctb ctb changed the title [WIP] update documentation & add notebooks to docs [MRG] update documentation & add notebooks to docs Feb 23, 2019
@ctb
Copy link
Contributor Author

ctb commented Feb 23, 2019

Ready for review @luizirber @taylorreiter @bluegenes - once this is reviewed and OKed, I will update all the references to the add/nbsphinx branch to point to master, and then merge.

@taylorreiter
Copy link
Contributor

  • I don't see the "Notebooks" section at sourmash.readthedocs.io
  • I like that you link to other notebooks at the bottom of each notebook
  • "sourmash: working with private collections of signatures" In[2] currently has output that indicates the signatures are already present, so the calculations do not occur. I can't find the big_genomes directory to see whether this is expected behavior (did big_genomes get switched to genomes?). If it is, maybe we should make a note of it in the notebook?

Otherwise, LGTM!

@ctb
Copy link
Contributor Author

ctb commented Mar 3, 2019

Thanks @taylorreiter!

Curious - why are you looking for the Notebooks section? :) (I had that in earlier, but then I refactored.) Do I have a reference to it somewhere?

Thanks for the catch re big_genomes! It's created in the top of the notebook (mkdir -p ...) so that's no problem; I've redone the signature calculation and pushed updates.

If it looks good, I think it's ready to be approved (and then I'll go update all of the URLs before merging)

Copy link
Member

@luizirber luizirber left a comment

Choose a reason for hiding this comment

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

Fix the binder/environment.yml channel order, and good to go!

binder/environment.yml Outdated Show resolved Hide resolved
@ctb
Copy link
Contributor Author

ctb commented Mar 6, 2019

ok. maybe I didn't do this right? but it should be ready.

@ctb
Copy link
Contributor Author

ctb commented Mar 6, 2019

(that is, ready to be approved. I'll need to do the branch name editing before merging.)

@luizirber
Copy link
Member

@ctb it's approved now. MacOS wheel building seems to be failing on Travis, probably related to pypa/cibuildwheel#122 (will check)

@ctb ctb merged commit 8797eb6 into master Mar 7, 2019
@ctb ctb deleted the add/nbsphinx branch March 7, 2019 01:35
@ctb
Copy link
Contributor Author

ctb commented Mar 7, 2019

thx all!

luizirber pushed a commit that referenced this pull request Mar 19, 2019
This reorganizes the documentation and adds Jupyter notebooks + binder links. 

* remove out of date notebooks

* remove outdated scripts

* configure nbsphinx and add a test notebook

* add nbsphinx to reqs

* add 2019-upr-kmers notebooks and example files

* add/update notebooks

* add binder configuration

* remove dockerfile

* update notebooks, link into documentation

* fix formatting issue that looks like a typo

* update basic sourmash tutorial commands to work, mostly

* fix sourmash_databases link

* updated tutorials

* fix spacing

* significant documentation reorganization and (hopefully) simplification

* add tutorial master index back in

* add dashing and hulk refs

* add bigsi

* fix branch reference for notebook so that it works

* update notebook with signature recalculation

* fix order of bioconda channels

* fix URLs
ctb pushed a commit that referenced this pull request Mar 27, 2024
Updates the requirements on
[pytest-cov](https://github.com/pytest-dev/pytest-cov) to permit the
latest version.
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/pytest-dev/pytest-cov/blob/master/CHANGELOG.rst">pytest-cov's
changelog</a>.</em></p>
<blockquote>
<h2>5.0.0 (2024-03-24)</h2>
<ul>
<li>Removed support for xdist rsync (now deprecated).
Contributed by Matthias Reichenbach in
<code>[#623](pytest-dev/pytest-cov#623)
&lt;https://github.com/pytest-dev/pytest-cov/pull/623&gt;</code>_.</li>
<li>Switched docs theme to Furo.</li>
<li>Various legacy Python cleanup and CI improvements.
Contributed by Christian Clauss and Hugo van Kemenade in
<code>[#630](pytest-dev/pytest-cov#630)
&lt;https://github.com/pytest-dev/pytest-cov/pull/630&gt;</code><em>,
<code>[#631](pytest-dev/pytest-cov#631)
&lt;https://github.com/pytest-dev/pytest-cov/pull/631&gt;</code></em>,
<code>[#632](pytest-dev/pytest-cov#632)
&lt;https://github.com/pytest-dev/pytest-cov/pull/632&gt;</code>_ and
<code>[#633](pytest-dev/pytest-cov#633)
&lt;https://github.com/pytest-dev/pytest-cov/pull/633&gt;</code>_.</li>
<li>Added a <code>pyproject.toml</code> example in the docs.
Contributed by Dawn James in
<code>[#626](pytest-dev/pytest-cov#626)
&lt;https://github.com/pytest-dev/pytest-cov/pull/626&gt;</code>_.</li>
<li>Modernized project's pre-commit hooks to use ruff. Initial POC
contributed by
Christian Clauss in
<code>[#584](pytest-dev/pytest-cov#584)
&lt;https://github.com/pytest-dev/pytest-cov/pull/584&gt;</code>_.</li>
</ul>
<h2>4.1.0 (2023-05-24)</h2>
<ul>
<li>Updated CI with new Pythons and dependencies.</li>
<li>Removed rsyncdir support. This makes pytest-cov compatible with
xdist 3.0.
Contributed by Sorin Sbarnea in
<code>[#558](pytest-dev/pytest-cov#558)
&lt;https://github.com/pytest-dev/pytest-cov/pull/558&gt;</code>_.</li>
<li>Optimized summary generation to not be performed if no reporting is
active (for example,
when <code>--cov-report=''</code> is used without
<code>--cov-fail-under</code>).
Contributed by Jonathan Stewmon in
<code>[#589](pytest-dev/pytest-cov#589)
&lt;https://github.com/pytest-dev/pytest-cov/pull/589&gt;</code>_.</li>
<li>Added support for JSON reporting.
Contributed by Matthew Gamble in
<code>[#582](pytest-dev/pytest-cov#582)
&lt;https://github.com/pytest-dev/pytest-cov/pull/582&gt;</code>_.</li>
<li>Refactored code to use f-strings.
Contributed by Mark Mayo in
<code>[#572](pytest-dev/pytest-cov#572)
&lt;https://github.com/pytest-dev/pytest-cov/pull/572&gt;</code>_.</li>
<li>Fixed a skip in the test suite for some old xdist.
Contributed by a bunch of people in
<code>[#565](pytest-dev/pytest-cov#565)
&lt;https://github.com/pytest-dev/pytest-cov/pull/565&gt;</code>_.</li>
</ul>
<h2>4.0.0 (2022-09-28)</h2>
<p><strong>Note that this release drops support for
multiprocessing.</strong></p>
<ul>
<li>
<p><code>--cov-fail-under</code> no longer causes <code>pytest
--collect-only</code> to fail
Contributed by Zac Hatfield-Dodds in
<code>[#511](pytest-dev/pytest-cov#511)
&lt;https://github.com/pytest-dev/pytest-cov/pull/511&gt;</code>_.</p>
</li>
<li>
<p>Dropped support for multiprocessing (mostly because <code>issue 82408
&lt;https://github.com/python/cpython/issues/82408&gt;</code>_). This
feature was
mostly working but very broken in certain scenarios and made the test
suite very flaky and slow.</p>
<p>There is builtin multiprocessing support in coverage and you can
migrate to that. All you need is this in your
<code>.coveragerc</code>::</p>
<p>[run]
concurrency = multiprocessing</p>
</li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/5295ce01c84262cec88f31255e9ac538718f3047"><code>5295ce0</code></a>
Bump version: 4.1.0 → 5.0.0</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/1181b067972bf94569f8011f3b18f271690f9ab1"><code>1181b06</code></a>
Update changelog.</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/9757222e2e044361e70125ebdd96e5eb87395983"><code>9757222</code></a>
Fix a minor grammar error (<a
href="https://redirect.github.com/pytest-dev/pytest-cov/issues/636">#636</a>)</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/9f5cd81a0dbe3fe41681efdbef516c08988fe8ff"><code>9f5cd81</code></a>
Cleanup releasing instructions. Closes <a
href="https://redirect.github.com/pytest-dev/pytest-cov/issues/616">#616</a>.</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/93b5047ec5050d63c10a6fe16a09b671a7a03df8"><code>93b5047</code></a>
Add test for pyproject.toml loading without explicit --cov-config. Ref
<a
href="https://redirect.github.com/pytest-dev/pytest-cov/issues/508">#508</a>.</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/ff50860d7c67b920503745d92a3f0944cf41f982"><code>ff50860</code></a>
docs: add config instructions for pyproject.toml.</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/4a5a4b5fa4b1c63ddcab5cbc1813798c9b6f1d36"><code>4a5a4b5</code></a>
Keep GitHub Actions up to date with GitHub's Dependabot</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/1d7f55963d5138f41c452a946f7cca7e0b6ee8b2"><code>1d7f559</code></a>
Fix or remove URLs that are causing docs tests to fail</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/6a5af8e85b8242ac815f33e26adf9068f5f0ebc3"><code>6a5af8e</code></a>
Update changelog.</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/d9fe8dfed15023d3410dd299c5092e755b8981c2"><code>d9fe8df</code></a>
Switch to furo. Closes <a
href="https://redirect.github.com/pytest-dev/pytest-cov/issues/618">#618</a>.</li>
<li>Additional commits viewable in <a
href="https://github.com/pytest-dev/pytest-cov/compare/v4.0.0...v5.0.0">compare
view</a></li>
</ul>
</details>
<br />


Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
ctb pushed a commit that referenced this pull request Nov 5, 2024
Updates the requirements on
[pytest-cov](https://github.com/pytest-dev/pytest-cov) to permit the
latest version.
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/pytest-dev/pytest-cov/blob/master/CHANGELOG.rst">pytest-cov's
changelog</a>.</em></p>
<blockquote>
<h2>6.0.0 (2024-10-29)</h2>
<ul>
<li>Updated various documentation inaccuracies, especially on subprocess
handling.</li>
<li>Changed fail under checks to use the precision set in the coverage
configuration.
Now it will perform the check just like <code>coverage report</code>
would.</li>
<li>Added a <code>--cov-precision</code> cli option that can override
the value set in your coverage configuration.</li>
<li>Dropped support for now EOL Python 3.8.</li>
</ul>
<h2>5.0.0 (2024-03-24)</h2>
<ul>
<li>Removed support for xdist rsync (now deprecated).
Contributed by Matthias Reichenbach in
<code>[#623](pytest-dev/pytest-cov#623)
&lt;https://github.com/pytest-dev/pytest-cov/pull/623&gt;</code>_.</li>
<li>Switched docs theme to Furo.</li>
<li>Various legacy Python cleanup and CI improvements.
Contributed by Christian Clauss and Hugo van Kemenade in
<code>[#630](pytest-dev/pytest-cov#630)
&lt;https://github.com/pytest-dev/pytest-cov/pull/630&gt;</code><em>,
<code>[#631](pytest-dev/pytest-cov#631)
&lt;https://github.com/pytest-dev/pytest-cov/pull/631&gt;</code></em>,
<code>[#632](pytest-dev/pytest-cov#632)
&lt;https://github.com/pytest-dev/pytest-cov/pull/632&gt;</code>_ and
<code>[#633](pytest-dev/pytest-cov#633)
&lt;https://github.com/pytest-dev/pytest-cov/pull/633&gt;</code>_.</li>
<li>Added a <code>pyproject.toml</code> example in the docs.
Contributed by Dawn James in
<code>[#626](pytest-dev/pytest-cov#626)
&lt;https://github.com/pytest-dev/pytest-cov/pull/626&gt;</code>_.</li>
<li>Modernized project's pre-commit hooks to use ruff. Initial POC
contributed by
Christian Clauss in
<code>[#584](pytest-dev/pytest-cov#584)
&lt;https://github.com/pytest-dev/pytest-cov/pull/584&gt;</code>_.</li>
</ul>
<h2>4.1.0 (2023-05-24)</h2>
<ul>
<li>Updated CI with new Pythons and dependencies.</li>
<li>Removed rsyncdir support. This makes pytest-cov compatible with
xdist 3.0.
Contributed by Sorin Sbarnea in
<code>[#558](pytest-dev/pytest-cov#558)
&lt;https://github.com/pytest-dev/pytest-cov/pull/558&gt;</code>_.</li>
<li>Optimized summary generation to not be performed if no reporting is
active (for example,
when <code>--cov-report=''</code> is used without
<code>--cov-fail-under</code>).
Contributed by Jonathan Stewmon in
<code>[#589](pytest-dev/pytest-cov#589)
&lt;https://github.com/pytest-dev/pytest-cov/pull/589&gt;</code>_.</li>
<li>Added support for JSON reporting.
Contributed by Matthew Gamble in
<code>[#582](pytest-dev/pytest-cov#582)
&lt;https://github.com/pytest-dev/pytest-cov/pull/582&gt;</code>_.</li>
<li>Refactored code to use f-strings.
Contributed by Mark Mayo in
<code>[#572](pytest-dev/pytest-cov#572)
&lt;https://github.com/pytest-dev/pytest-cov/pull/572&gt;</code>_.</li>
<li>Fixed a skip in the test suite for some old xdist.
Contributed by a bunch of people in
<code>[#565](pytest-dev/pytest-cov#565)
&lt;https://github.com/pytest-dev/pytest-cov/pull/565&gt;</code>_.</li>
</ul>
<h2>4.0.0 (2022-09-28)</h2>
<p><strong>Note that this release drops support for
multiprocessing.</strong></p>
<ul>
<li><code>--cov-fail-under</code> no longer causes <code>pytest
--collect-only</code> to fail</li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/95404375a0e436178e012e20b8865c23c54c8a50"><code>9540437</code></a>
Bump version: 5.0.0 → 6.0.0</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/9f8175467afc67db9001fb364ad1f2dfe79b51f1"><code>9f81754</code></a>
Further trim down envs and drop Python 3.8.</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/b12b5ec65da4c66bbc0c35918957f9f875f465c3"><code>b12b5ec</code></a>
Update conf.</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/23f4b27b432a54fcc3b6df7363f0e73e568233fb"><code>23f4b27</code></a>
Update changelog.</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/291a04f49566054bb19644aba27c3799ac8b7f42"><code>291a04f</code></a>
Bump test deps and trim config.</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/08f1101455ba293dda388fdb3b61e62fd95a827d"><code>08f1101</code></a>
Add <code>--cov-precision</code> option. Close <a
href="https://redirect.github.com/pytest-dev/pytest-cov/issues/655">#655</a>.</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/76fe2a7e48e5c9c53644994c5ba5a421c84286f5"><code>76fe2a7</code></a>
Move the warnings/errors in a place that doesn't import anything.</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/a9ea7b71711479d4c5ccc5e21e2eb1694b259cb0"><code>a9ea7b7</code></a>
Implement error/warning for the bad dynamic_context being set in
config.</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/c299e01b6422284a6a7f7322e6b9bf8f44aa3c25"><code>c299e01</code></a>
Add explicit suffixing to make it easier to see the identify the
sources/usag...</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/c87e54643ef696ed2b0e2b9a4209581da8467fcb"><code>c87e546</code></a>
Add reproducer for weird xdist dynamic_context interaction. Ref <a
href="https://redirect.github.com/pytest-dev/pytest-cov/issues/604">#604</a>.</li>
<li>Additional commits viewable in <a
href="https://github.com/pytest-dev/pytest-cov/compare/v4.0.0...v6.0.0">compare
view</a></li>
</ul>
</details>
<br />


Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.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.

3 participants