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.

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

Create guide_streamlit.rst #1847

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Create guide_streamlit.rst #1847

wants to merge 3 commits into from

Conversation

entorb
Copy link
Contributor

@entorb entorb commented Dec 9, 2024

Based on Django guide, setup using non-root document root, as this way my use case.

@nichtmax
Copy link
Member

Thanks for your Guide! Please check the style guide: Don't mention additional document roots. Keep it simple. Don't use subfolders. Always use the standard document root ~/html. Always assume the document root is empty.

@nichtmax nichtmax marked this pull request as draft December 10, 2024 09:30
@entorb entorb marked this pull request as ready for review December 10, 2024 18:48
@entorb
Copy link
Contributor Author

entorb commented Dec 10, 2024

adjusted

Copy link
Member

@nichtmax nichtmax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! A few things left to change.

Oh and you can check a preview of your guide here, there's some blocks broken: https://deploy-preview-1847--uberlab.netlify.app/guide_streamlit/


After creating the configuration, tell :manual:`supervisord <daemons-supervisord>` to refresh its configuration and start the service:

::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use

.. include:: includes/supervisord.rst

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added

Add Web Backend
===============

.. code-block:: console
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use:

.. note::

    Streamlit is running on port 8501.

.. include:: includes/web-backend.rst

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added

source/guide_streamlit.rst Outdated Show resolved Hide resolved

.. tag_list::

Streamlit_ is a high-level Python Web framework focussing on data visualization. This guide is based on the :lab:`Django <guide_django>` guide.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's based on the Django Guide. I gave you the Django Guide as an example for another Python based guide, no need to mention it here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I used that file as a starting point, so quite some of the text in this guide are copied from there, so I find it important to quote the source.

@nichtmax nichtmax marked this pull request as draft December 11, 2024 13:57
@entorb
Copy link
Contributor Author

entorb commented Dec 11, 2024

I added your proposals. If more modifications are needed, feel free to directly apply them. I think that would be much faster than ping pong ;-)

@entorb entorb marked this pull request as ready for review December 13, 2024 06:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants