Skip to content

Show the documentation structure #248

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

Merged
merged 4 commits into from
Jan 31, 2023
Merged

Show the documentation structure #248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ad25ad8
Update pyproduct_library_structure_diag.rst
akaszynski Jan 30, 2023
990064d
add authors file
akaszynski Jan 30, 2023
83257be
bump 5.11.5
akaszynski Jan 30, 2023
0cd8f2e
FIX: links and names
jorgepiloto Jan 31, 2023
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
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ repos:
additional_dependencies: [black==22.12.0]

- repo: https://github.com/pycqa/isort
rev: 5.11.4
rev: 5.12.0
hooks:
- id: isort
args: [
Expand Down
11 changes: 11 additions & 0 deletions doc/source/packaging/code/authors_file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Authors

## Project Lead or Owner

* [First Last](https://github.com/ghusername)

## Contributors

* [Jane Smith](https://github.com/janesmith)
* [Jim Jones](https://github.com/jimjones)
* [Jack Johnson](https://github.com/jackjohnson)
16 changes: 16 additions & 0 deletions doc/source/packaging/diag/pyproduct_library_structure_diag.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,18 @@
label="doc", shape="folder"
]

source [
label="source", shape="folder"
]

src [
label="src", shape="folder"
]

conf_file [
label="conf.py", shape="file"
]

ansys [
label="ansys", shape="folder"
]
Expand All @@ -47,6 +55,10 @@
label="tests", shape="folder"
]

authors [
label="AUTHORS.md", shape="file"
]

changelog [
label="CHANGELOG.md", shape="file"
]
Expand Down Expand Up @@ -79,6 +91,7 @@
pyproduct_library -> doc;
pyproduct_library -> src;
pyproduct_library -> tests;
pyproduct_library -> authors;
pyproduct_library -> license;
pyproduct_library -> changelog;
pyproduct_library -> code_of_conduct;
Expand All @@ -87,6 +100,9 @@
pyproduct_library -> pyproject;
pyproduct_library -> setup;

doc -> source;
source -> conf_file;

src -> ansys;
ansys -> product;
product -> library;
Expand Down
12 changes: 12 additions & 0 deletions doc/source/packaging/structure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,18 @@ This is the preferred way of naming directories and files inside the
``tests/`` directory.



The ``AUTHORS.md`` file
-----------------------
An ``AUTHORS.md`` file is used to list the authors of the repository. It is
used to credit the authors for their individual contributions and provide a
record of authorship for the codebase. Use your first and last name and provide
a link to your GitHub username.

.. literalinclude:: code/authors_file.md
:language: markdown


The ``CHANGELOG.md`` file
-------------------------

Expand Down