Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating documentation about existing directory structure. #320

Merged
merged 1 commit into from
Dec 15, 2023
Merged

Updating documentation about existing directory structure. #320

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/source/existing_project.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,13 @@ However, some of the tools that the template includes expect that
the package source code will be in a first level directory named ``src``, and
that tests will be contained in a first level directory named ``tests``.

For example, if your project is in a directory named ``/science``, your source
code and tests might look like this:
For example, if your project is in a directory named ``/science``, and your package
is named ``new_science``, your source code and tests might look like this:

.. code:: bash

/science/src/module.py
/science/tests/test_module.py
/science/src/new_science/module.py
/science/tests/new_science/test_module.py

If your directory structure for source code and tests is significantly
different than this, it might be worth reorganizing the files in order to make use
Expand Down