mirror of
https://github.com/TeamPGM/pyrogram.git
synced 2024-11-30 17:43:32 +00:00
Update docs
This commit is contained in:
parent
2faad4f781
commit
21d521fb60
@ -95,6 +95,9 @@ def generate(source_path, base):
|
|||||||
module = "pyrogram.api.{}".format(base)
|
module = "pyrogram.api.{}".format(base)
|
||||||
|
|
||||||
with open(destination + "/" + inner_path, "w") as f:
|
with open(destination + "/" + inner_path, "w") as f:
|
||||||
|
# if k == base:
|
||||||
|
# f.write(":tocdepth: 1\n\n")
|
||||||
|
|
||||||
f.write(
|
f.write(
|
||||||
toctree.format(
|
toctree.format(
|
||||||
title=k.title(),
|
title=k.title(),
|
||||||
|
60
docs/source/_templates/footer.html
Normal file
60
docs/source/_templates/footer.html
Normal file
@ -0,0 +1,60 @@
|
|||||||
|
<footer>
|
||||||
|
{% if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||||
|
{% if next %}
|
||||||
|
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
{% endif %}
|
||||||
|
{% if prev %}
|
||||||
|
<a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> {{ _('Previous') }}</a>
|
||||||
|
{% endif %}
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>
|
||||||
|
{%- if show_copyright %}
|
||||||
|
{%- if hasdoc('copyright') %}
|
||||||
|
{% trans path=pathto('copyright'), copyright=copyright|e %}© <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
|
||||||
|
{%- else %}
|
||||||
|
{% trans copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %}
|
||||||
|
{%- endif %}
|
||||||
|
{%- endif %}
|
||||||
|
|
||||||
|
<div>
|
||||||
|
<b><a href="https://github.com/pyrogram/pyrogram">Pyrogram</a></b> documentation
|
||||||
|
© Copyright 2017 - 2018, Dan Tès
|
||||||
|
</div>
|
||||||
|
<p>
|
||||||
|
Licensed under the
|
||||||
|
<a href="https://creativecommons.org/licenses/by/3.0/">Creative Commons Attribution 3.0 License</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
{%- if build_id and build_url %}
|
||||||
|
{% trans build_url=build_url, build_id=build_id %}
|
||||||
|
<span class="build">
|
||||||
|
Build
|
||||||
|
<a href="{{ build_url }}">{{ build_id }}</a>.
|
||||||
|
</span>
|
||||||
|
{% endtrans %}
|
||||||
|
{%- elif commit %}
|
||||||
|
{% trans commit=commit %}
|
||||||
|
<span class="commit">
|
||||||
|
Revision <code>{{ commit }}</code>.
|
||||||
|
</span>
|
||||||
|
{% endtrans %}
|
||||||
|
{%- elif last_updated %}
|
||||||
|
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
|
||||||
|
{%- endif %}
|
||||||
|
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{%- if show_sphinx %}
|
||||||
|
{% trans %}Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %}.
|
||||||
|
{%- endif %}
|
||||||
|
|
||||||
|
{%- block extrafooter %} {% endblock %}
|
||||||
|
|
||||||
|
</footer>
|
@ -84,27 +84,31 @@ language = None
|
|||||||
exclude_patterns = []
|
exclude_patterns = []
|
||||||
|
|
||||||
# The name of the Pygments (syntax highlighting) style to use.
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
pygments_style = 'sphinx'
|
pygments_style = 'tango'
|
||||||
|
|
||||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||||
todo_include_todos = False
|
todo_include_todos = False
|
||||||
|
|
||||||
# -- Options for HTML output ----------------------------------------------
|
# -- Options for HTML output ----------------------------------------------
|
||||||
|
|
||||||
|
# Overridden by template
|
||||||
|
html_show_copyright = False
|
||||||
|
|
||||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
# a list of builtin themes.
|
# a list of builtin themes.
|
||||||
#
|
#
|
||||||
html_theme = 'sphinx_rtd_theme'
|
html_theme = 'sphinx_rtd_theme'
|
||||||
|
|
||||||
html_theme_options = {
|
|
||||||
'collapse_navigation': False
|
|
||||||
}
|
|
||||||
|
|
||||||
# Theme options are theme-specific and customize the look and feel of a theme
|
# Theme options are theme-specific and customize the look and feel of a theme
|
||||||
# further. For a list of options available for each theme, see the
|
# further. For a list of options available for each theme, see the
|
||||||
# documentation.
|
# documentation.
|
||||||
#
|
#
|
||||||
# html_theme_options = {}
|
html_theme_options = {
|
||||||
|
'canonical_url': "https://docs.pyrogram.ml/",
|
||||||
|
'collapse_navigation': False,
|
||||||
|
'sticky_navigation': False,
|
||||||
|
'logo_only': True
|
||||||
|
}
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top
|
# The name of an image file (relative to this directory) to place at the top
|
||||||
# of the sidebar.
|
# of the sidebar.
|
||||||
|
Loading…
Reference in New Issue
Block a user