Spaces:
Runtime error
Runtime error
File size: 3,288 Bytes
58a91e1 4e54bd9 58a91e1 4e54bd9 58a91e1 4e54bd9 58a91e1 4e54bd9 58a91e1 4e54bd9 58a91e1 4e54bd9 58a91e1 9c405cd 58a91e1 9c405cd 58a91e1 cfca180 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
import streamlit as st
from Login import auth_page
st.set_page_config(
page_title="Usage",
layout="wide",
page_icon="📝",
initial_sidebar_state="expanded",
)
st.markdown("## :rainbow[Welcome to Techdocs: Where Code Meets Clarity!]🚀")
def logout():
del st.session_state["access_token"]
del st.session_state["refresh_token"]
del st.session_state["username"]
with st.sidebar.expander("🧑Account Details",expanded=True):
if 'username' not in st.session_state:
st.warning("Please Login or Signup to continue")
else:
st.info(f"Welcome, {st.session_state.username}! 😄")
if st.button("Logout 👋"):
logout()
st.rerun()
def usage():
st.markdown("### :rainbow[How to use Techdocs?]")
# col1,col2 = st.columns(2,gap="small")
# with col1:
# st.image("/frontend/assets/image.png")
# st.caption("Boat sailing in the sea")
# with col2:
# intro_text="""
# Now that you've arrived at this digital crossroads, you're most likely eager to dive into the world of Techdocs. Great choice! In today's fast-paced tech landscape, having well-structured and easily accessible documentation is like having a treasure map to navigate the vast ocean of code. You are probably wondering how to use Techdocs.
# """
# text="""
# But you might be wondering: "How do I embark on this documentation journey with Techdocs?" Fear not, because we're about to chart a course through the fascinating world of Techdocs, where clarity, efficiency, and ease-of-use are the guiding stars.
# """
# st.write(f'<p style="font-size:20px; color:#9c9d9f ">{intro_text}</p>', unsafe_allow_html=True)
# st.write(f'<p style="color:#9c9d9f; font-size:20px">{text}</p>', unsafe_allow_html=True)
st.markdown("### 📝 :rainbow[Using Techdocs via the CLI]")
st.info("Please use the CLI to generate the documentation for your project. The Streamlit app is just a preview to give the user an idea of the project.")
st.warning("The API Key can only be generated from the Techdocs Streamlit app. To start using the CLI, please generate an API Key from the Streamlit app.")
with st.expander("⚙️ Installation and setup",expanded=True):
st.text("1. Create a virtual environment. We recommend using conda but you can python's venv as well:"); st.code("conda create -n techdocs python=3.11","python")
st.text("2. Install Techdocs via pip:"); st.code("pip install techdocs","python")
st.text("3. CD into your project directory.")
st.code("CD <YOUR-PROJECT-DIRECTORY>","bash")
st.text("4. Login into our Techdocs Streamlit app or signup if you don't have an account.")
st.text("5. Generate an API Key from the Code page and paste it in the command below.")
st.code("techdocs -k <API_KEY> -u <USERNAME> -p <PASSWORD> -d <ROOT-DIRECTORY-OF-THE -PROJECT>","bash")
st.text("6. Wait for the documentation to be generated. You can view the status of the documentation generation in the CLI.")
if 'access_token' not in st.session_state:
st.session_state.runpage = auth_page
else:
st.session_state.runpage = usage
st.session_state.runpage()
|