Skip to content

Restructure the CossanObjects tutorial folder #39

Open
@FriesischScott

Description

@FriesischScott

Currently all CossanObjects tutorials live in a single folder under docs/tutorials/CossanObjects. Since there are too many files to easily scan the folder for the required info I suggest to restructure the tutorials in the following way:

|-- +opencossan
|-- docs
	|-- classes
		|-- common
			|-- inputs
				|-- TutorialFunction.m
				|-- TutorialInput.m
				|-- ...
			|-- TutorialModel.m
			|-- ...
		|-- reliablity
			|-- TutorialDesignPoint.m
			|-- ...
		|-- sensitivity
			|-- TutorialMonteCarlo.m
			|-- ...
		|-- ...
	|-- tutorials
		|-- CantileverBeam
		|-- IshigamiFunction
		|-- ...

By leveraging the same structure as the source packages, the tutorials for any class can be quickly found by the user. Less files in each folder is significantly cleaner.

This will also clearly separate the full tutorials from the class/object tutorials.

In addition, this will hopefully allow for a nicer structure if we do figure out a way to generate nice documentation from the tutorials.

Thoughts, @etheban ?

Metadata

Metadata

Assignees

No one assigned

    Labels

    developmentDevelopment versiondocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions