-
Notifications
You must be signed in to change notification settings - Fork 172
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* changelog and contributor files, renamed from .md to .rst
* Sidebar. Additional information included: - About intro - Useful Links * Modified files: - index.rst: * Added how to install two or more optional extra tools * Contents. Extracted to contents.rst file, and updated (including index.rst, changelog.rst) - supported_tools.rst: * Minor changes * New note: about using pep257 / pydocstyle name - contrib.rst: * python version supported updated * added list of contributors (reference from root folder) * added information about Tool Classes (autodoc from source). Those also populate Index references. - profiles.rst: * Information has been organized as following: - Global configuration options - Individual configuration options - Final example with most options. * Doc Configuration (conf.py): - Prospector Version extracted from installed prospector source code. - New extensions autodoc and viewcode -> Used to extract Tool Classes. - Html theme changed from default to alabaster Please let me know your kind feedback. Don't hesitate to modify/change if required.
- Loading branch information
Showing
18 changed files
with
668 additions
and
223 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
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
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,21 @@ | ||
<h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3> | ||
|
||
<ul> | ||
<li><a href="{{ pathto('index') }}">1. Home</a></li> | ||
<li><a href="{{ pathto('usage') }}">2. Command Line Usage</a></li> | ||
<li><a href="{{ pathto('profiles') }}">3. Profiles / Configuration</a></li> | ||
<li><a href="{{ pathto('suppression') }}">4. Error Suppression</a></li> | ||
<li><a href="{{ pathto('supported_tools') }}">5. Supported tools</a></li> | ||
<li><a href="{{ pathto('contrib') }}">6. Contributing</a></li> | ||
<li><a href="{{ pathto('changelog') }}">Changelog</a></li> | ||
<li><a href="{{ pathto('contents') }}">Contents</a></li> | ||
</ul> | ||
|
||
{%- if display_toc %} | ||
<hr> | ||
{{ toc }} | ||
{%- endif %} | ||
|
||
<hr> | ||
<a href="{{ pathto('genindex') }}">Index</a> | ||
<hr> |
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,52 @@ | ||
{# | ||
|
||
Copied from: | ||
|
||
https://raw.githubusercontent.com/pallets/pallets-sphinx-themes/b0c6c41849b4e15cbf62cc1d95c05ef2b3e155c8/src/pallets_sphinx_themes/themes/pocoo/layout.html | ||
|
||
And removed the warning version (see #7331). | ||
|
||
#} | ||
|
||
{% extends "basic/layout.html" %} | ||
|
||
{% set metatags %} | ||
{{- metatags }} | ||
<meta name="viewport" content="width=device-width, initial-scale=1"> | ||
{%- endset %} | ||
|
||
{% block extrahead %} | ||
{%- if page_canonical_url %} | ||
<link rel="canonical" href="{{ page_canonical_url }}"> | ||
{%- endif %} | ||
<script>DOCUMENTATION_OPTIONS.URL_ROOT = '{{ url_root }}';</script> | ||
{{ super() }} | ||
{%- endblock %} | ||
|
||
{% block sidebarlogo %} | ||
{% if pagename != "index" or theme_index_sidebar_logo %} | ||
{{ super() }} | ||
{% endif %} | ||
{% endblock %} | ||
|
||
{% block relbar2 %}{% endblock %} | ||
|
||
{% block sidebar2 %} | ||
<span id="sidebar-top"></span> | ||
{{- super() }} | ||
{%- endblock %} | ||
|
||
{% block footer %} | ||
{{ super() }} | ||
{%- if READTHEDOCS and not readthedocs_docsearch %} | ||
<script> | ||
if (typeof READTHEDOCS_DATA !== 'undefined') { | ||
if (!READTHEDOCS_DATA.features) { | ||
READTHEDOCS_DATA.features = {}; | ||
} | ||
READTHEDOCS_DATA.features.docsearch_disabled = true; | ||
} | ||
</script> | ||
{%- endif %} | ||
{{ js_tag("_static/version_warning_offset.js") }} | ||
{% endblock %} |
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,7 @@ | ||
<h3>Useful Links</h3> | ||
<ul> | ||
<li><a href="https://pypi.org/project/prospector/">prospector @ PyPI</a></li> | ||
<li><a href="https://github.com/PyCQA/prospector/">prospector @ GitHub</a></li> | ||
<li><a href="https://github.com/PyCQA/prospector/issues">Issue Tracker</a></li> | ||
<li><a href="http://prospector.landscape.io/en/master/">Documentation</a> | ||
</ul> |
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,19 @@ | ||
<h3>Related Topics</h3> | ||
<ul> | ||
<li><a href="{{ pathto(master_doc) }}">Contents</a><ul> | ||
{%- for parent in parents %} | ||
<li><a href="{{ parent.link|e }}">{{ parent.title }}</a><ul> | ||
{%- endfor %} | ||
{%- if prev %} | ||
<li>Previous: <a href="{{ prev.link|e }}" title="{{ _('previous chapter') | ||
}}">{{ prev.title }}</a></li> | ||
{%- endif %} | ||
{%- if next %} | ||
<li>Next: <a href="{{ next.link|e }}" title="{{ _('next chapter') | ||
}}">{{ next.title }}</a></li> | ||
{%- endif %} | ||
{%- for parent in parents %} | ||
</ul></li> | ||
{%- endfor %} | ||
</ul></li> | ||
</ul> |
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,4 @@ | ||
<h3>About prospector</h3> | ||
<p> | ||
Prospector runs your favourite linters in a useful way | ||
</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 |
---|---|---|
@@ -0,0 +1,15 @@ | ||
{# | ||
basic/searchbox.html with heading removed. | ||
#} | ||
{%- if pagename != "search" and builder != "singlehtml" %} | ||
<div id="searchbox" style="display: none" role="search"> | ||
<div class="searchformwrapper"> | ||
<form class="search" action="{{ pathto('search') }}" method="get"> | ||
<input type="text" name="q" aria-labelledby="searchlabel" | ||
placeholder="Search"/> | ||
<input type="submit" value="{{ _('Go') }}" /> | ||
</form> | ||
</div> | ||
</div> | ||
<script type="text/javascript">$('#searchbox').show(0);</script> | ||
{%- endif %} |
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,5 @@ | ||
.. _`changelog`: | ||
|
||
.. include:: ../CHANGELOG.rst | ||
|
||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
Contents | ||
--------- | ||
|
||
.. toctree:: | ||
:caption: Table of Contents | ||
:maxdepth: 2 | ||
:numbered: 1 | ||
|
||
index | ||
usage | ||
profiles | ||
suppression | ||
supported_tools | ||
contrib | ||
|
||
|
||
.. only:: html | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
changelog |
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
Oops, something went wrong.