jcody49 / recipe_app

0 stars 0 forks source link

Documentation #2

Open jcody49 opened 8 months ago

jcody49 commented 8 months ago

I'm getting pretty confused on using Sphinx to generate my documentation from my docstrings and jsdocs.

I have all jsdocs and docstrings in place.

I have installed Sphinx, and run quickstart, so I have all of the folders and files in project that come with that. I have procured an index.rst for my Cookbook_Collective root that references the index.rst for recipe_project and recipes.

When I run the command to build the html output, it isn't accessing my docstrings or jsdocs to generate the documentation, despite programming it to do so:

.. The Cookbook Collective documentation master file, created by sphinx-quickstart on Sat Feb 24 19:21:57 2024. You can adapt this file completely to your liking, but it should at least contain the root toctree directive.

Welcome to The Cookbook Collective's documentation!

.. toctree:: :maxdepth: 2 :caption: Contents:

recipe_project/index jsdocs/index

Indices and tables