Ecosyste.ms: Repos
An open API service providing repository metadata for many open source software ecosystems.
GitHub / t4ngo / sphinxcontrib-traceables
Sphinx extension that adds traceability within documentation
JSON API: https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/t4ngo%2Fsphinxcontrib-traceables
Stars: 3
Forks: 5
Open Issues: 7
License: other
Language: Python
Repo Size: 201 KB
Dependencies:
187
Created: over 8 years ago
Updated: over 1 year ago
Last pushed: over 5 years ago
Last synced: 26 days ago
Files
Loading...
Readme
Loading...
Dependencies
- Contents *
- Traceablesexampleproject *
- strs *
- syrs *
- verif *
- Ausermustbeabletodefinetraceablesatarbitrarylocationswithin *
- Ausermustbeabletodisplaytraceables ,theirattributes,andtheir
- Ausermustbeabletospecifyinaflexibleandpowerfulwaywhich *
- AverycommonwaytoinstallPythonpackagesistousethe *
- Capturingrequirementsindocumentation *
- Describingprocessesasnetworksoflinkeditems ,i.e.
- Developerreleasestheextension *
- Developersrequiredocumentationtohelpthemunderstandandimprove *
- Developerworksontheextension *
- DocumentPurpose *
- DocumentScope *
- DocumentStructure *
- Example *
- Extensiondevelopers *
- Extensionusers *
- Ifausermakesanerrorinhisusageofthisextension ,thenthis
- Inthisexamplethegoalistoshowtheparentsandthechildrenofagiven *
- Inthisexamplethegoalistoshowtherelationshipsbetweenprocesses ,
- Introduction *
- Itconsistsofthefollowingactivities *
- Itmustbepossibletoconfigurethetypesofrelationshipsthatare *
- Itmustthereforebepossibleforuserstoeasilyinstallthisextension *
- OperationalConcept *
- Requirementsfordevelopersworkingonthisextension *
- Requirementsforfunctionalitywhenwritingdocswiththisextension *
- Requirementsforinstallationandrunning *
- Sphinx-baseddocumentation. *
- Sphinxautomaticallyreportsongeneralsyntaxerrorsinitsinputfiles ,
- SphinxsourcefilesusingstandardreStructuredTextconstructs *
- StakeholderRequirements *
- StakeholdersRequirementsSpecification *
- StakeholdersandTheirNeeds *
- The *
- Thedefinitionofatraceablemust *
- Thedevelopers *
- Theerrormessagestobegeneratedbythisextensionaremainlyrelated *
- Thefollowingchaptersdescribethestakeholdersandtheirneeds ,combinethose
- Thefollowingtypesofoutputmustbesupported *
- Themaximumlength *
- Theseuserneedsarecapturedinthe *
- Thespecificationmustsupportatleasttheusageexamplesgiveninthe *
- Theusers *
- ThevalidrelationshiptypescanbeconfiguredviaSphinx *
- ThisStakeholdersRequirementsSpecificationdocumentidentifiestheparties *
- Thisdocument *
- Thisdocumentdescribesthe *
- Thisexampleincludesbothparentandchildrelationshipsintheoutput *
- Thisexamplerevolvesaroundausagescenariowhereprocessesandtheir *
- ThisextensionaddstraceabilityfunctionalitytoSphinx.Itsuserscan *
- Thisscenariocoversadeveloperwhocreatesaformalreleaseofthis *
- Thisscenariocoversadeveloperwhoworksonthisextension ,expandingits
- Thisscenariocoversauserwantstheoutputdocumentationtoinclude *
- Thisscenariocoversauserwhoinstallsthisextension.Itconsistsof *
- ThisscenariocoversauserwhowritesSphinx-baseddocumentationthat *
- Thisstakeholderrepresentsdevelopersofthe *
- Thisstakeholderrepresentsusersofthe *
- Thoseneedsarecapturedinthe *
- Usergenerategraphsshowingrelationshipsbetweentraceables *
- Userinstallstheextension *
- Usersrequiredocumentationtohelpthemusethisextension.That *
- Userwritesdocumentation *
- adiagramshouldbegeneratedshowingthelinkagesbetweenprocesseswithout *
- andiseasytouse *
- andkeepingthetextualdescriptionthereofinlinewithdiagramsby *
- andviceversa.Thisleadstoanontrivialspecificationofwhichtraceables *
- anotherprocessbymeansofoneormoreofitsoutputsforminganinputfor *
- applysuchtraceabilityforvariousdifferentpurposes ,suchasforexample
- automaticallygeneratingdiagrams ,tables,relationships,etc.from
- below. *
- betweenvarioustypesofrequirements *
- butwithoutincludingtheinputs *
- caneasilybeunderstoodandsothatmodifications *
- color ,orfoo
- combinesthediverseneedsinan *
- configurable.Ifnotspecified ,thecompletehierarchiesshouldbeshown.
- configurationmethod ,namelyinthe
- containstraceablesandotherfunctionalityprovidedbythisextension. *
- demonstratehowthisextensionallowsrequirementsmanagementwithin *
- derivedfromit *
- diagram.However ,Therelationshiptypesarenot
- diagramsofrequirements ,andfilteringthosebasedonflexibleproperties
- documentation ,specificallytheinstallationinstructions.
- documentationmustcoveratleastthefollowingtopics *
- documentationtolearnhowtousetheextension *
- expand ,easytomaintain,funtoworkon,etc.
- extension ,i.e.peoplewhocreate,expand,andmaintainit.
- extension ,i.e.peoplewhowriteSphinx
- extensionandpublishesthatsothatuserscaninstallthenewrelease *
- extensionmeetsitsstakeholders *
- extensionshouldgiveaclearerrormessagethathelpstheuserquickly *
- findandfixtheerror *
- fixtheerror. *
- functionality *
- functionality ,fixingbugs,writesdocumentationforit,etc.
- generatedgraphsshowingtherelationshipsbetweentraceables. *
- givesclearerrormessageshelpingtheusertoquicklyunderstandand *
- ifaccepted ,inclusioninthecentralrepository
- implementedin-linewithitsdesignphilosophy *
- inputsandoutputsareeachrepresentedbyatraceable.Aprocessislinkedto *
- interestedinthe *
- needsintoasingle *
- notneedtohandlesucherrors. *
- ofgraphsinmoredetail *
- oftherequirements *
- overloadingthereaderwithalltheinput *
- relationships *
- relationshipsthroughoutthedocumentationoutput. *
- relationshiptypes *
- requirements. *
- see *
- settings. *
- showallchildrenofatraceableonthe *
- showingtheintermediaryinput *
- standardmethodsincludedhere *
- thefollowingactivities *
- theotherprocessorviceversa. *
- thetextualdescription. *
- thisextension.Thatdocumentationmustcoveratleastthefollowing *
- throughouttherestofthedocumentationset *
- toinclude. *
- toinvalidparametersgiventoitsdirectivesandinvalidconfiguration *
- tooneside ,anditschildrenhierarchytotheotherside.
- topics *
- tostakeholder-levelaspectsandthereforedoesn *
- traceable *
- traceable.Thedesiredoutputgraphshowsthetraceable *
- traceableitems ,suchastraceabilitymatricesandgraphs
- traceables *
- traceablestobeincludedingraphoutput *
- understand *
- usefulinsimplifyingthedisplayoflinkagesbetweenprocesseswithout *
- usingthe *
- usuallywritteninreStructuredTextformat.Thisextensionthereforedoes *
- validforadocumentationset *
- withinSphinxdocumentation *
- Directivecontentdefinesarbitraryinformationthatisassociatedwith *
- Directiveoptionsdefinethetraceable *
- DocumentPurpose *
- DocumentScope *
- DocumentStructure *
- DocumentationRequirements *
- FunctionalRequirements *
- Introduction *
- ItmustbepossibletodefineatraceableusingareSTdirective. *
- ItmustbepossibletogeneratelistsoftraceablesusingareST *
- ItmustbepossibletogeneratematricesoftraceablesusingareST *
- Listofsystemrequirements *
- Sphinx-baseddocumentation. *
- StakeholderRequirements *
- SystemRequirements *
- SystemRequirementsSpecification *
- The *
- ThecontentisparsedasreSTcode. *
- Thefollowingchaptersdescribe... *
- Theuserdocumentationmustdescribehowtousethefeaturesprovidedby *
- ThisSystemRequirementsSpecificationdocument... *
- Thisdocument *
- Thisdocumentdescribesthe *
- Traceability *
- Usabilityrequirements *
- demonstratehowthisextensionallowsrequirementstobecapturedwithin *
- directive.Thedirective *
- functionalrequirements *
- havespecialmeaning *
- infull ,butotherwisenotusedintraceableprocessing,filtering,etc.
- ofthisextension *
- relationshipswithothertraceables *
- requirementsfordevelopmentofthisextension ,andontheotherhand,to
- theoutput. *
- thetraceable.Itisshowninlinewherethetraceableisdisplayed *
- thisextension.Itmustcoveratleastallfeaturesasstatedbythe *
- tosystem-levelaspects. *
requirements.txt
pypi