Hi.
In my current app I want to link (and package) the sphinx-generated documentation for the project and make it accessible via a button or link at the bottom of the sidebar in the streamlit app.
A pop-over hovering over the app would be neat, but opening a new tab and showing the sphinx docs would also work for me.
Maybe I don’t see the obvious?
PS: Currently, the html files are created using tox.
has anyone done this?
Hi @cwerner -
There are some open issues for serving static content from a folder. At that point, you could link to the generated HTML pages and it would work:
In the meantime, you could read the HTML into a string (using the file open(..., 'r') built-in method), then use components.html to display the content. Depending on what you want to do with the content, there are various ways of hiding the content or optionally displaying the HTML.
These cookies are necessary for the website to function and cannot be switched off. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us understand how visitors move around the site and which pages are most frequently visited.
These cookies are used to record your choices and settings, maintain your preferences over time and recognize you when you return to our website. These cookies help us to personalize our content for you and remember your preferences.
These cookies may be deployed to our site by our advertising partners to build a profile of your interest and provide you with content that is relevant to you, including showing you relevant ads on other websites.