Skip to content

Commit

Permalink
docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
n-wbrown committed Jul 24, 2024
1 parent 2e0f8b2 commit ecfe0d8
Showing 1 changed file with 23 additions and 19 deletions.
42 changes: 23 additions & 19 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,11 @@
Python Package and Notebook Cookiecutter
========================================

A project template for python projects and notebooks. This package is primarily intended for researchers to organize small projects
consisting of modules and notebooks.
A project template for python projects and notebooks. This template is intended for researchers to organize small projects consisting of modules and notebooks.

To learn more about cookiecutter:

- Project Homepage: https://cookiecutter.readthedocs.io/en/latest/
- Cookiecutter Homepage: https://cookiecutter.readthedocs.io/en/latest/
- Github: https://github.com/audreyr/cookiecutter

Project Status
Expand Down Expand Up @@ -72,37 +71,41 @@ The directory structure of your new project looks like this:

.. code-block:: text
├── .github/ <- GitHub templates and workflow settings
├── {{ import_name }} <- Source code for use in this project.
├── .gitignore <- Gitignore for the repo
├── {{ import_name }} <- Source code for use in this project.
│ │
│ ├── __init__.py <- Init file for the project
│ ├── __init__.py <- Init file for the project
│ │
│ └── tests <- Tests for the module
│ └── tests <- Tests for the module
│ │
│ ├── __init__.py <- Init file for the tests
│ ├── __init__.py <- Init file for the tests
│ │
│ └── conftest.py <- Pytest conftest file
│ └── conftest.py <- Pytest conftest file
├── .logging.yml <- Yaml configuration for Python logging
├── docs <- A default Sphinx project; see sphinx-doc.org for details
├── LICENSE <- License for the project
├── dev-requirements.txt <- Requirements to develop and test the package
├── MANIFEST.in <- setup.py manifest of files
├── docs-requirements.txt <- Requirements to make the sphinx documentation
├── README.rst <- The top-level README for developers using this project
├── .gitignore <- Gitignore for the repo
├── requirements.txt <- The requirements to install the project.
├── .logging.yml <- Yaml configuration for Python logging
├── .github/ <- (Optional) GitHub templates and workflow settings
├── LICENSE <- License for the project
├── docs <- (Optional) A default Sphinx project; see sphinx-doc.org for details
├── MANIFEST.in <- setup.py manifest of files
├── data <- (Optional) An empty directory for data and links
├── README.rst <- The top-level README for developers using this project
├── output <- (Optional) An empty directory for results
├── requirements.txt <- The requirements to install the project.
├── dev-requirements.txt <- (Optional) Requirements to develop the package and execute the test suite
├── docs-requirements.txt <- (Optional) Requirements to generate the sphinx documentation
├── run_tests.py <- Script that runs the files in the tests directory
Installing Development Requirements
Expand All @@ -113,6 +116,7 @@ Installing Development Requirements
$ pip install -Ur dev-requirements.txt
$ pip install -Ur docs-requirements.txt


Acknowledgements
----------------
This repository is forked from from the work of SLAC National Accelerator Laboratory's controls team for the LCLS project. You can visit their original repository here: https://github.com/pcdshub/cookiecutter-pcds-python.

0 comments on commit ecfe0d8

Please sign in to comment.