Skip to content

Commit

Permalink
fix docs links (#11)
Browse files Browse the repository at this point in the history
  • Loading branch information
jbloom authored Dec 14, 2023
1 parent 38ebcda commit 2e01ae4
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 9 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,8 @@ The pipeline will only run to completion when all all QC filters are passed.
If the pipeline runs to completion, it will create HTML documentation with plots of the overall titers, per-serum titer analyses, and per-plate analyses in a docs subdirectory, which will typically named be `./docs/` (if you use suggested key in configuration YAML).
This HTML documentation can be rendered via [GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) from the `./docs/` directory.

The documentation for the test example for this pipeline is at [https://jbloomlab.github.io/seqneut-pipeline/](https://jbloomlab.github.io/seqneut-pipeline/).

## Test example and testing via GitHub Actions
The [./test_example](test_example) subdirectory contains a small test example that illustrates use of the pipeline.

Expand Down
14 changes: 7 additions & 7 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ <h2 id="plot-of-titers-for-all-sera">Plot of titers for all sera</h2>
<p><a href="../docs/titers.html">Interactive chart of titers</a></p>
<h2 id="analyses-of-per-serum-neutralization-titers">Analyses of per-serum neutralization titers</h2>
<ul>
<li><a href="../docs/serum_titers_M099d0.html">M099d0</a></li>
<li><a href="../docs/serum_titers_M099d30.html">M099d30</a></li>
<li><a href="../docs/serum_titers_Y044d30.html">Y044d30</a></li>
<li><a href="../docs/serum_titers_Y154d182.html">Y154d182</a></li>
<li><a href="serum_titers_M099d0.html">M099d0</a></li>
<li><a href="serum_titers_M099d30.html">M099d30</a></li>
<li><a href="serum_titers_Y044d30.html">Y044d30</a></li>
<li><a href="serum_titers_Y154d182.html">Y154d182</a></li>
</ul>
<h2 id="analyses-of-per-plate-counts-and-curve-fits">Analyses of per-plate counts and curve fits</h2>
<ul>
<li><a href="../docs/process_counts_plate2.html">plate2</a></li>
<li><a href="../docs/process_counts_plate11.html">plate11</a></li>
</ul>
<li><a href="process_counts_plate2.html">plate2</a></li>
<li><a href="process_counts_plate11.html">plate11</a></li>
</ul>
4 changes: 2 additions & 2 deletions scripts/build_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@

assert len(snakemake.params.sera) == len(snakemake.input.serum_titers_htmls)
for serum, f in zip(snakemake.params.sera, snakemake.input.serum_titers_htmls):
md_text.append(f" - [{serum}]({copied_files[f]})")
md_text.append(f" - [{serum}]({os.path.basename(copied_files[f])})")

md_text += ["", "## Analyses of per-plate counts and curve fits"]
assert len(snakemake.params.plates) == len(snakemake.input.process_counts_htmls)
for plate, f in zip(snakemake.params.plates, snakemake.input.process_counts_htmls):
md_text.append(f" - [{plate}]({copied_files[f]})")
md_text.append(f" - [{plate}]({os.path.basename(copied_files[f])})")

md_text = "\n".join(md_text)

Expand Down

0 comments on commit 2e01ae4

Please sign in to comment.