Skip to content

doc ref cleanup #1

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 2 commits into from
Mar 3, 2025
Merged

doc ref cleanup #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3cdf628
chg: dev: cleanup doc refs, replace DID contents, apply pre-comnmit
sarnold Mar 3, 2025
1937994
chg: usr: flesh out SDD starter with DID sections, add example rst hdrs
sarnold Mar 3, 2025
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
4 changes: 2 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
default: docs

docs:
$(MAKE) -C std
$(MAKE) -C sdd

clean:
$(MAKE) -C std clean
$(MAKE) -C sdd clean
19 changes: 12 additions & 7 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,16 @@
What is this thing?
===================

This is both a GitHub Template repository *and* a usable template for a
DID-compliant Software Test Description in reStructuredText_. This repo contains
the following items:
This is both a GitHub Template repository *and* a usable doc template
for a DID-compliant Software Test Description in reStructuredText_. The
actual "template" comes in 2 parts, the actual DID content requirements
outline and description, and the starter document with some example
content based on the fictional ACME company's Engineering Unit Software
Design Description.

* A Data Item Descripttion for a Software Test Description (SDD)
This repo contains the following items:

* A Data Item Descripttion for a Software Design Description (SDD)
in ASCII text format
* A DID-compliant SDD outline using all the required DID sections (in
reStructuredText format)
Expand All @@ -41,11 +46,11 @@ Contents after a fresh clone::
├── pyproject.toml
├── requirements-dia.txt
├── resources # these are references or pre-inputs to the build workflow
│   ├── SDD_DID_DI-IPSC-81439.txt # Software Test Description DID
│   ├── SDD_DID_DI-IPSC-81435.txt # Software Design Description DID
│   ├── example-title-page.rst # example title page source
│   └── acme_webservice.py # source code for the example system diagram
├── std
│   ├── EU_SDD.rst # source code for the document/template
├── sdd
│   ├── EU_SDD.rst # source code for the starter document (template)
│   ├── Makefile
│   ├── images # graphics sources for document build
│   │   ├── acme.png
Expand Down
Loading
Loading