Closed anissa111 closed 4 months ago
Just to clarify, is the docs/README automatically generated and added to the documentation any time the normal README gets updated? If it's actually a copy that needs to be manually updated, maybe we could adjust that; if it's automatically maintained then I think this should be good to merge in...
Related to: https://github.com/NCAR/CUPiD/issues/38#issuecomment-1946567725
Summary of changes:
README.md
README.md
indocs/index.rst
by copyingCUPiD/README.md
into the docs directory indocs/conf.py
and removes the logo in the top header because having an image in the heading puts it in the sidebar toc tree, which looks really weird.docs/README.md
to the.gitignore
because it should only be created/edited automatically during documentation generation and not actually committed to the repoSee local results: