Skip to content
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

Jump to bottom

Restructure the CossanObjects tutorial folder #39

Open
FriesischScott opened this issue Jun 12, 2020 · 2 comments
Open

Restructure the CossanObjects tutorial folder #39

FriesischScott opened this issue Jun 12, 2020 · 2 comments
Labels
development Development version documentation Improvements or additions to documentation

Comments

@FriesischScott
Copy link
Member

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 ?
@FriesischScott FriesischScott added development Development version documentation Improvements or additions to documentation labels Jun 12, 2020
@etheban
Copy link
Contributor

etheban commented Jun 12, 2020 via email

@FriesischScott
Copy link
Member Author

Coolio, I'll see if I can get a pull request together. While I do that I will also see if we can turn more of the tutorials into integration tests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
development Development version documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@FriesischScott @etheban