Commit af905a5e authored by David Hendriks's avatar David Hendriks
Browse files

rebuilding the docs

parent 1117151f
Loading
Loading
Loading
Loading

HOW_TO_CONTRIBUTE

0 → 100644
+1 −0
Original line number Diff line number Diff line
You can contribute by contacting me (david) or rob and asking what needs to be done
+2 −2
Original line number Diff line number Diff line
@@ -58,8 +58,8 @@ def grid_options_description_checker(print_info=True):
    return len(undescribed_keys)


grid_options_help('amt_cores')
# grid_options_help('amt_cores')

grid_options_description_checker()
# grid_options_description_checker()

+19 −1
Original line number Diff line number Diff line
* Notes:
** Building
builing the HTML requires the following python packages:
- sphinx
- clang
- hawkmoth
- m2r
- m2r2

We need to run the following couple of commands before the eventual html should be made: 
- script to generate all the binary_c commands and explanations
- script to generate all the binarycpython grid commands and explanations



** info
https://stackoverflow.com/questions/20059953/linking-to-source-code-file-in-sphinx
https://stackoverflow.com/questions/39534718/how-to-create-a-pdf-out-of-sphinx-documentation-tool

* Todo:
** TODO Write script to automatically rebuild the whole bunch
** TODO: use typing from mypy and build that into the docs
** TODO use typing from mypy and build that into the docs
https://github.com/seqan/seqan3-doc/blob/user/source/make_source.py
https://www.pythonforthelab.com/blog/documenting-with-sphinx-and-readthedocs/
** TODO Hijack the make command to add some extra documents
+21 −0
Original line number Diff line number Diff line
<?xml version="1.0" encoding="UTF-8"?>
<svg xmlns="http://www.w3.org/2000/svg" width="99" height="20">
    <linearGradient id="b" x2="0" y2="100%">
        <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
        <stop offset="1" stop-opacity=".1"/>
    </linearGradient>
    <mask id="a">
        <rect width="99" height="20" rx="3" fill="#fff"/>
    </mask>
    <g mask="url(#a)">
        <path fill="#555" d="M0 0h63v20H0z"/>
        <path fill="#e05d44" d="M63 0h36v20H63z"/>
        <path fill="url(#b)" d="M0 0h99v20H0z"/>
    </g>
    <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11">
        <text x="31.5" y="15" fill="#010101" fill-opacity=".3">coverage</text>
        <text x="31.5" y="14">coverage</text>
        <text x="80" y="15" fill="#010101" fill-opacity=".3">5%</text>
        <text x="80" y="14">5%</text>
    </g>
</svg>
+2333 −0

File added.

Preview size limit exceeded, changes collapsed.

Loading