Docs stub

.gitignore

@@ -8,3 +8,6 @@
 # phpunit
 /.phpunit.result.cache
 /reports
+
+# docs
+/docs/build

docs/_templates/sidebar/brand.html

@@ -0,0 +1,22 @@
+<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

@@ -0,0 +1,10 @@
+from datetime import datetime
+
+project = 'Path Library'
+author = 'Anton Smirnov'
+copyright = '{} {}'.format(datetime.now().year, author)
+language = 'en'
+
+html_title = project
+html_theme = 'furo'
+templates_path = ["_templates"]

docs/index.rst

@@ -0,0 +1,37 @@
+Torrent File
+############
+
+|Packagist| |GitLab| |GitHub| |Bitbucket| |Gitea|
+
+A PHP Class to work with torrent files
+
+Installation
+============
+
+.. code-block:: bash
+
+   composer require arokettu/path
+
+Documentation
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+License
+=======
+
+The library is available as open source under the terms of the `MIT License`_.
+
+.. _MIT License: https://opensource.org/licenses/MIT
+
+.. |Packagist|  image:: https://img.shields.io/packagist/v/arokettu/path.svg?style=flat-square
+   :target:     https://packagist.org/packages/arokettu/path
+.. |GitHub|     image:: https://img.shields.io/badge/get%20on-GitHub-informational.svg?style=flat-square&logo=github
+   :target:     https://github.com/arokettu/path
+.. |GitLab|     image:: https://img.shields.io/badge/get%20on-GitLab-informational.svg?style=flat-square&logo=gitlab
+   :target:     https://gitlab.com/sandfox/path
+.. |Bitbucket|  image:: https://img.shields.io/badge/get%20on-Bitbucket-informational.svg?style=flat-square&logo=bitbucket
+   :target:     https://bitbucket.org/sandfox/path
+.. |Gitea|      image:: https://img.shields.io/badge/get%20on-Gitea-informational.svg?style=flat-square&logo=gitea
+   :target:     https://sandfox.org/sandfox/path

docs/requirements.txt

@@ -0,0 +1 @@
+furo