Notes
  • business
    • coding
      • cli commands
        • dev
          • c
            • css
              • js
                • py
                  • Automated Documentation Generation with Sphinx
                  • Generate a short human readable unique ID in Python
                  • Matplotlib Dates
                  • Matplotlib Server Backend
                  • Python Secret State Sharing
                • web
                  • How to write good documentation
                  • kcproxy
                  • My Coding Principles
                  • My Working Principles
                • devops
                  • git
                    • llm-assisted
                      • notes
                        • prompts
                          • raycast
                            • coding
                          • concepts
                            • design
                              • drawings
                                • obsidian
                                  • resources
                                    • stuff
                                      • Notes
                                      • Working Note
                                      Navigation

                                      • All tags
                                      • #excalidraw(3)

                                      No backlinks yet.

                                      No linked pages yet.

                                      Local graph
                                      1. coding /
                                      2. dev /
                                      3. py /
                                      4. Automated Documentation Generation with Sphinx

                                      Automated Documentation Generation with Sphinx

                                      Install

                                      pip install sphinx 
                                      

                                      Build with

                                      sphinx-build -b html docs/source/ docs/build/html
                                      

                                      Also use Read the Docs for deploying sphinx docs.
                                      Plus, use the VSCode autodoc extension to generate sphinx-style docstrings.

                                      RTD-Tutorial: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html

                                      Link: https://www.sphinx-doc.org/en/master/tutorial/getting-started.html