Commit f8d063c5 authored by Anton Smirnov's avatar Anton Smirnov
Browse files

Update from templates

parent b5420ab8

.gitattributes

+3 −0
Original line number Diff line number Diff line 
# template

/docs/*.py          export-ignore

/docs/*.txt         export-ignore

/docs/_*            export-ignore
@@ -7,3 +8,5 @@ 
/*.yaml             export-ignore

/*.xml              export-ignore

/*.xml.dist         export-ignore



# project

.readthedocs.yaml

+7 −2
Original line number Diff line number Diff line 
version: 2



build:

  os: 'ubuntu-22.04'

  tools:

    python: '3.11'



sphinx:

  configuration: docs/conf.py

  configuration: 'docs/conf.py'



python:

  install:

    - requirements: docs/requirements.txt
 
  - requirements: 'docs/requirements.txt'

docs/_templates/rtd-version.html

0 → 100644
+3 −0
Original line number Diff line number Diff line 
{%- if current_version -%}

    <div class="sidebar-brand">{{ current_version }}</div>

{%- endif -%}

docs/_templates/sidebar/brand.html

deleted100644 → 0
+0 −22
Original line number Diff line number Diff line 
<a class="sidebar-brand{% if logo %} centered{% endif %}" href="{{ pathto(master_doc) }}">

    {% block brand_content %}

    {%- if logo %}

    <div class="sidebar-logo-container">

        <img class="sidebar-logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>

    </div>

    {%- endif %}

    {%- if theme_light_logo and theme_dark_logo %}

    <div class="sidebar-logo-container">

        <img class="sidebar-logo only-light" src="{{ pathto('_static/' + theme_light_logo, 1) }}" alt="Light Logo"/>

        <img class="sidebar-logo only-dark" src="{{ pathto('_static/' + theme_dark_logo, 1) }}" alt="Dark Logo"/>

    </div>

    {%- endif %}

    {% if not theme_sidebar_hide_name %}

    <span class="sidebar-brand-text">{{ docstitle }}</span>

    {%- endif %}

    {% endblock brand_content %}

</a>



{%- if current_version -%}

    <div class="sidebar-brand">{{ current_version }}</div>

{%- endif -%}

docs/conf.py

+19 −1
Original line number Diff line number Diff line 
from datetime import datetime



project = 'Bencode'

# import specific project config

import os, sys

sys.path.append(os.curdir)

from conf_project import *



author = 'Anton Smirnov'

copyright = '{} {}'.format(datetime.now().year, author)

language = 'en'
@@ -8,3 +12,17 @@ language = 'en' 
html_title = project

html_theme = 'furo'

templates_path = ["_templates"]

html_sidebars = {

    "**": [

        "sidebar/brand.html",

        "rtd-version.html",

        "sidebar/search.html",

        "sidebar/scroll-start.html",

        "sidebar/navigation.html",

        "sidebar/ethical-ads.html",

        "sidebar/scroll-end.html",

        "sidebar/variant-selector.html",

    ]

}



exclude_patterns = ['venv/*']