Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📝 Update index.rst file #236

Merged
merged 2 commits into from
Jul 8, 2023
Merged

📝 Update index.rst file #236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4fcd5d
:memo: Update index.rst file with new width and add example and FMO c…
mraniki Jul 8, 2023
ec68b3f
:whale: Update Dockerfile with new dependencies
mraniki Jul 8, 2023
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
10 changes: 8 additions & 2 deletions .registry/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
FROM python:3.11
WORKDIR /app
COPY ./examples/ /.requirements/requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt
#COPY ./examples/ /.requirements/requirements.txt .
#RUN pip install --no-cache-dir -r requirements.txt

COPY ./examples/ .
RUN pip install --no-cache-dir findmyorder
RUN pip install --no-cache-dir fastapi
RUN pip install --no-cache-dir uvicorn

EXPOSE 8080
CMD [ "python", "./example.py" ]
14 changes: 11 additions & 3 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ FindMyOrder

.. image:: https://user-images.githubusercontent.com/8766259/233823991-cceaa05a-ff15-4796-a6bb-bcb3ee0d8859.jpg
:align: right
:width: 200
:width: 50


.. toctree::
Expand All @@ -17,14 +17,23 @@ FindMyOrder

How To Use it
==================
the following example illustrate how to use the module

.. rli:: https://raw.githubusercontent.com/mraniki/findmyorder/main/examples/example.py
:language: python
:lines: 10-29


Settings
==================
Setting available via settings.toml

.. rli:: https://raw.githubusercontent.com/mraniki/findmyorder/main/findmyorder/default_settings.toml
:language: python

FMO class
==================
* :doc:`findmyorder <findmyorder:main>`



Indices and tables
Expand All @@ -35,7 +44,6 @@ Indices and tables
* :ref:`search`



Talky
==================
* :doc:`Talkytrader <talkytrader:index>`
Expand Down