Skip to content

Commit 73c4b79

Browse files
authored
Package structure and docs updated (#24)
* Structure updated to 4th iteration * Docs settings updated * Docs updated
1 parent d2c4845 commit 73c4b79

40 files changed

+285
-370
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ If applicable, add screenshots to help explain your problem.
2828
- Version [e.g. 10, Ubuntu 20.04]
2929

3030
**Additional context**
31-
Add any other context about the problem here.
31+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/documentation_improvement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ Explain why this improvement would be beneficial to the project.
1717
Provide a suggestion or example of how the documentation could be improved.
1818

1919
**Additional context**
20-
Add any other context or screenshots related to the documentation improvement here.
20+
Add any other context or screenshots related to the documentation improvement here.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ A clear and concise description of what you want to happen.
1717
A clear and concise description of any alternative solutions or features you've considered.
1818

1919
**Additional context**
20-
Add any other context or screenshots about the feature request here.
20+
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ A clear and concise question about the project.
1414
List any documentation or sources you consulted before asking.
1515

1616
**Additional context**
17-
Add any other context or screenshots related to your question here.
17+
Add any other context or screenshots related to your question here.

.vscode/extensions.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
"github.vscode-github-actions",
1111
"bierner.markdown-mermaid",
1212
"alexcvzz.vscode-sqlite",
13-
"njpwerner.autodocstring"
13+
"njpwerner.autodocstring",
14+
"redhat.vscode-yaml",
1415
]
1516
}

.vscode/settings.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,17 @@
1919
"iis.configDir": "",
2020
// AutoDocstring settings
2121
"autoDocstring.docstringFormat": "google",
22+
// MkDocs settings
23+
"yaml.schemas": {
24+
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
25+
},
26+
"yaml.customTags": [
27+
"!ENV scalar",
28+
"!ENV sequence",
29+
"!relative scalar",
30+
"tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
31+
"tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
32+
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format",
33+
"tag:yaml.org,2002:python/object/apply:pymdownx.slugs.slugify mapping"
34+
]
2235
}

CONTRIBUTING.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -115,15 +115,11 @@ mkdocs serve
115115
4. Make sure your code follows the project's style guidelines
116116
5. Wait for review feedback
117117

118-
## Code of Conduct
119-
120-
All contributors must follow our [Code of Conduct](CODE_OF_CONDUCT.md).
121-
122118
## Questions?
123119

124120
If you encounter issues or need assistance with development, you can:
125121

126122
- Create an issue in the [GitHub repository](https://github.com/vybornak2/fatpy/issues)
127-
- Contact the maintainers at jan.vyborny2@gmail.com
123+
- Contact the maintainers at <jan.vyborny2@gmail.com>
128124

129125
Thank you for contributing to FatPy!

docs/api/core/energy_life.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/api/core/index.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/api/core/strain_life.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

0 commit comments

Comments
 (0)