Skip to content
This repository has been archived by the owner on Oct 8, 2023. It is now read-only.

From markdown to restructuredtext #199

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion build.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

# Calling Cython to compile our extensions.
cython = os.path.join(os.path.dirname(sys.executable), 'cython')
process = subprocess.run([cython] + list(pending_compilation) + ['--fast-fail'])
process = subprocess.run([cython] + list(pending_compilation) + ['--fast-fail', '-X', 'embedsignature=true'])
if process.returncode != 0:
raise SystemExit(f'Failed to compile .pyx files to C.')

Expand Down
37 changes: 37 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
API
===

.. toctree::
:maxdepth: 2
:caption: Contents:

api/cache
api/client
api/components
api/headers
api/multipart
api/protocol
api/request
api/responses
api/router
api/schemas
api/sessions
api/templates
api/websockets
api/workers
api/application
api/blueprints
api/constants
api/context
api/cookies
api/exceptions
api/hooks
api/limits
api/optimizer
api/server
api/static
api/utils
api/parsers


.. automodule:: vibora
4 changes: 4 additions & 0 deletions docs/api/application.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Application
===========

.. automodule:: vibora.application
4 changes: 4 additions & 0 deletions docs/api/blueprints.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Blueprints
==========

.. automodule:: vibora.blueprints
4 changes: 4 additions & 0 deletions docs/api/cache.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Cache
=====

.. .. automodule:: vibora.cache.cache
28 changes: 28 additions & 0 deletions docs/api/client.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Client
======

.. automodule:: vibora.client

.. automodule:: vibora.client.session

.. automodule:: vibora.client.response

.. automodule:: vibora.client.retries

.. automodule:: vibora.client.connection

.. automodule:: vibora.client.decoders

.. automodule:: vibora.client.defaults

.. automodule:: vibora.client.exceptions

.. automodule:: vibora.client.limits

.. automodule:: vibora.client.pool

.. automodule:: vibora.client.request

.. automodule:: vibora.client.response

.. automodule:: vibora.client.websocket
7 changes: 7 additions & 0 deletions docs/api/components.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Components
==========

.. automodule:: vibora.components.components

.. I have no Idea why this is needed
.. automodule:: vibora.components.context
5 changes: 5 additions & 0 deletions docs/api/constants.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Constants
=========

.. automodule:: vibora.constants

5 changes: 5 additions & 0 deletions docs/api/context.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Context
=======

.. automodule:: vibora.context

5 changes: 5 additions & 0 deletions docs/api/cookies.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Cookies
=======

.. automodule:: vibora.cookies

5 changes: 5 additions & 0 deletions docs/api/exceptions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Exceptions
==========

.. automodule:: vibora.exceptions

5 changes: 5 additions & 0 deletions docs/api/headers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Headers
=======

.. automodule:: vibora.headers.headers

5 changes: 5 additions & 0 deletions docs/api/hooks.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Hooks
=====

.. automodule:: vibora.hooks

5 changes: 5 additions & 0 deletions docs/api/limits.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Limits
======

.. automodule:: vibora.limits

7 changes: 7 additions & 0 deletions docs/api/multipart.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Multipart
=========

.. automodule:: vibora.multipart.parser

.. automodule:: vibora.multipart.containers

5 changes: 5 additions & 0 deletions docs/api/optimizer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Optimizer
=========

.. automodule:: vibora.optimizer

10 changes: 10 additions & 0 deletions docs/api/parsers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Parsers
=======

.. automodule:: vibora.parsers.parser

.. automodule:: vibora.parsers.response

.. automodule:: vibora.parsers.errors

.. automodule:: vibora.parsers.typing
11 changes: 11 additions & 0 deletions docs/api/protocol.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Protocol
========

.. automodule:: vibora.protocol

.. automodule:: vibora.protocol.definitions

.. automodule:: vibora.protocol.cprotocol

.. automodule:: vibora.protocol.cwebsocket

5 changes: 5 additions & 0 deletions docs/api/request.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Request
=======

.. automodule:: vibora.request

5 changes: 5 additions & 0 deletions docs/api/responses.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Responses
=========

.. automodule:: vibora.responses

6 changes: 6 additions & 0 deletions docs/api/router.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Router
======

.. automodule:: vibora.router.router

.. automodule:: vibora.router.parser
20 changes: 20 additions & 0 deletions docs/api/schemas.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Schemas
=======

.. automodule:: vibora.schemas

.. automodule:: vibora.schemas.extensions.fields

.. automodule:: vibora.schemas.extensions.schemas

.. automodule:: vibora.schemas.extensions.validator

.. automodule:: vibora.schemas.exceptions

.. automodule:: vibora.schemas.messages

.. automodule:: vibora.schemas.schemas

.. automodule:: vibora.schemas.types

.. automodule:: vibora.schemas.validators
5 changes: 5 additions & 0 deletions docs/api/server.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Server
======

.. automodule:: vibora.server

8 changes: 8 additions & 0 deletions docs/api/sessions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Sessions
========

.. automodule:: vibora.sessions.base

.. automodule:: vibora.sessions.client

.. automodule:: vibora.sessions.files
5 changes: 5 additions & 0 deletions docs/api/static.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Static
======

.. automodule:: vibora.static

17 changes: 17 additions & 0 deletions docs/api/templates.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Templates
=========

.. automodule:: vibora.templates.template
.. automodule:: vibora.templates.engine
.. automodule:: vibora.templates.ast
.. automodule:: vibora.templates.cache
.. automodule:: vibora.templates.compilers.base
.. automodule:: vibora.templates.compilers.cython
.. automodule:: vibora.templates.compilers.helpers
.. automodule:: vibora.templates.compilers.python
.. automodule:: vibora.templates.exceptions
.. automodule:: vibora.templates.extensions
.. automodule:: vibora.templates.loader
.. automodule:: vibora.templates.nodes
.. automodule:: vibora.templates.parser
.. automodule:: vibora.templates.utils
5 changes: 5 additions & 0 deletions docs/api/utils.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Utils
=====

.. automodule:: vibora.utils

5 changes: 5 additions & 0 deletions docs/api/websockets.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Websockets
==========

.. automodule:: vibora.websockets.obj

8 changes: 8 additions & 0 deletions docs/api/workers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Workers
=======

.. automodule:: vibora.workers.handler

.. automodule:: vibora.workers.necromancer

.. automodule:: vibora.workers.reaper
Empty file removed docs/client/examples.md
Empty file.
Empty file removed docs/client/initial.md
Empty file.
Empty file removed docs/client/session.md
Empty file.
Empty file removed docs/client/websocket.md
Empty file.
87 changes: 0 additions & 87 deletions docs/components/initial.md

This file was deleted.

Loading