-
-
Notifications
You must be signed in to change notification settings - Fork 74
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
documentation building, readthedocs config (#203)
- Loading branch information
Showing
18 changed files
with
996 additions
and
1,342 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| codecov: | ||
| token: c2f0ce36-17ad-4668-bb1b-f1b72dedf3fc | ||
| comment: | ||
| after_n_builds: 9 | ||
|
|
||
| coverage: | ||
| status: | ||
| project: | ||
| default: | ||
| target: auto | ||
| threshold: 2.0% | ||
| informational: true | ||
| patch: | ||
| default: | ||
| target: auto | ||
| threshold: 20% | ||
| informational: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # Read the Docs configuration file for Sphinx projects | ||
| # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
|
||
| # Required | ||
| version: 2 | ||
|
|
||
| # Set the OS, Python version and other tools you might need | ||
| build: | ||
| os: ubuntu-22.04 | ||
| tools: | ||
| python: "3.11" | ||
| # You can also specify other tool versions: | ||
| # nodejs: "20" | ||
| # rust: "1.70" | ||
| # golang: "1.20" | ||
|
|
||
| # Build documentation in the "docs/" directory with Sphinx | ||
| sphinx: | ||
| configuration: docs/conf.py | ||
| # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs | ||
| # builder: "dirhtml" | ||
| # Fail on all warnings to avoid broken references | ||
| # fail_on_warning: true | ||
|
|
||
| # Optionally build your docs in additional formats such as PDF and ePub | ||
| # formats: | ||
| # - epub | ||
|
|
||
| # Optional but recommended, declare the Python requirements required | ||
| # to build your documentation | ||
| # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html | ||
| # python: | ||
| # install: | ||
| # - requirements: docs/requirements.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| <h5> Get <tt>uncertainties</tt></h5> | ||
| <p>Current version: <b>{{ release }}</b></p> | ||
|
|
||
| <p> | ||
| Installation: <br> | ||
| <tt> pip install uncertainties</tt> | ||
|
|
||
| <p> | ||
| Development Version: | ||
| <a href="https://github.com/lmfit/uncertainties/">Github</a> | ||
| </p> | ||
|
|
||
|
|
||
| <h5>Offline Documentation</h5> | ||
|
|
||
| <p> | ||
| <a href="uncertainties.pdf">uncertainties.pdf</a> | ||
| <br> | ||
| <a href="uncertainties_doc.zip">Zipped HTML and PDF</a> | ||
| </p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,93 +1,23 @@ | ||
| {% extends "!layout.html" %} | ||
|
|
||
| {% block rootrellink %} | ||
| {{ toctree() }} | ||
| {% endblock %} | ||
|
|
||
| {% block document %} | ||
| {{ super() }} | ||
| <a href="https://github.com/lebigot/uncertainties"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/652c5b9acfaddf3a9c326fa6bde407b87f7be0f4/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f6f72616e67655f6666373630302e706e67" alt="Fork me on GitHub" height="137px" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png"></a> | ||
| <li>[<a href="{{ pathto('index') }}">Home</a></li> | ||
| <li>[<a href="{{ pathto('install') }}">Installation & Credits</a></li> | ||
| <li>|<a href="{{ pathto('user_guide') }}">User Guide</a></li> | ||
| <li>|<a href="{{ pathto('formatting') }}">Formatting</a></li> | ||
| <li>|<a href="{{ pathto('numpy_guide') }}"> Numpy Arrays</a></li> | ||
| <li>|<a href="{{ pathto('tech_guide') }}">Advanced Topics</a>]</li> | ||
| | ||
| | ||
| {% endblock %} | ||
|
|
||
| {% block relbar1 %} | ||
|
|
||
| <div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px"> | ||
| <a href="{{ pathto('index') }}"><img src="{{ | ||
| pathto("_static/logo.png", 1) }}" border="0" alt="uncertainties"/></a> | ||
| <div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px"> | ||
| <font size=+2> | ||
| <a href="{{ pathto('index') }}"> | ||
| <img src="{{pathto("_static/logo.png", 1) }}" height=75 border="0" alt="uncertainties logo"/> | ||
| </a> | ||
| </font> | ||
| </div> | ||
| {{ super() }} | ||
| {% endblock %} | ||
|
|
||
|
|
||
| {#############################################################################} | ||
| {# Sidebar customization #) | ||
|
|
||
| {# put the sidebar before the body #} | ||
| {% block sidebar1 %} | ||
|
|
||
| {%- macro sidebar() %} | ||
| {%- if not embedded %}{% if not theme_nosidebar|tobool %} | ||
| <div class="sphinxsidebar"> | ||
| <div class="sphinxsidebarwrapper"> | ||
| {%- block sidebarlogo %} | ||
| {%- if logo %} | ||
| <p class="logo"><a href="{{ pathto(master_doc) }}"> | ||
| <img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/> | ||
| </a></p> | ||
| {%- endif %} | ||
| {%- endblock %} | ||
| {%- block sidebartoc %} | ||
| {%- block sidebarglobaltoc %} | ||
| <h3>{{ _('Table of contents') }}</h3> | ||
| {{ toctree() }} | ||
| {%- endblock %} | ||
| {%- endblock %} | ||
| {%- block sidebarrel %} | ||
| {%- endblock %} | ||
| {%- block sidebarsourcelink %} | ||
| {%- if show_source and has_source and sourcename %} | ||
| <h3>{{ _('This Page') }}</h3> | ||
| <ul class="this-page-menu"> | ||
| <li><a href="{{ pathto('_sources/' + sourcename, true)|e }}" | ||
| rel="nofollow">{{ _('Show Source') }}</a></li> | ||
| </ul> | ||
| {%- endif %} | ||
| {%- endblock %} | ||
| {%- if customsidebar %} | ||
| {% include customsidebar %} | ||
| {%- endif %} | ||
| {%- if display_toc %} | ||
| <h3>{{ _('Section contents') }}</h3> | ||
| {{ toc }} | ||
| {%- endif %} | ||
| {%- block sidebarsearch %} | ||
| {%- if pagename != "search" %} | ||
| <div id="searchbox" style="display: none"> | ||
| <h3>{{ _('Quick search') }}</h3> | ||
| <form class="search" action="{{ pathto('search') }}" method="get"> | ||
| <input type="text" name="q" size="18" /> | ||
| <input type="submit" value="{{ _('Go') }}" /> | ||
| <input type="hidden" name="check_keywords" value="yes" /> | ||
| <input type="hidden" name="area" value="default" /> | ||
| </form> | ||
| <p class="searchtip" style="font-size: 90%"> | ||
| {{ _('Search the documentation.') }} | ||
| </p> | ||
| </div> | ||
| <script type="text/javascript">$('#searchbox').show(0);</script> | ||
| {%- endif %} | ||
| {%- endblock %} | ||
| {%- block copyright %} | ||
| <h3>Documentation license</h3> | ||
| <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by-sa/3.0/88x31.png" /></a> | ||
| {%- endblock %} | ||
| </div> | ||
| </div> | ||
| {%- endif %}{% endif %} | ||
| {%- endmacro %} | ||
|
|
||
| {{ sidebar() }}{% endblock %} | ||
|
|
||
|
|
||
| {% block sidebar2 %}{% endblock %} | ||
|
|
Oops, something went wrong.