Example new structure

[pritkc]

What type of PR is this? (check all applicable)

• Refactor
• [] Feature
• Bug Fix
• Optimization
• Example
• Documentation

Description

Related Issues & Documents

• Closes #

QA Instructions, Screenshots, Recordings

Please replace this line with instructions on how to test your changes, a note
on the devices and browsers this has been tested on, as well as any relevant
images for UI changes.

Added/updated tests?

_We encourage you to test all code included with MOLE, including examples.

• Yes
• [ X ] No, and this is why: please replace this line with details on why tests
  have not been included
• I need help with writing tests

Read Contributing Guide and Code of Conduct

• I have read and followed the Contributing Guide and the Code of Conduct

[optional] Are there any post deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

[pritkc]

[1] Pending the reviews of the files.
[2] Upon completion of [1], the existing static paths to the examples (i.e., sphinx direct calls) will be replaced.

[valeriabarra]

Hi @pritkc , thank you for opening the PR.

I would modify the examples/index.md file with a bit of description of the directory tree. For instance, that we organize examples by PDE-type and then by dimensionality.

Also, referring to the libCEED model, I would also add to the toc the individual subdirectory index.md files for our subdirectories. Thank you

[valeriabarra]

Also, I think we need to move the content out of examples/examples.md to the different relevant subdirectories

[pritkc]

Hi @valeriabarra, Thank you for reviewing these changes thoroughly. Adding a few follow-up questions on quotes.

Also, I think we need to move the content out of examples/examples.md to the different relevant subdirectories

[1] Should I be moving individual Markdown examples to their MATLAB host directories? Considering we won't have any single C++ examples that are not available with its MATLAB counterpart.

Also, referring to the libCEED model, I would also add to the toc the individual subdirectory index.md files for our subdirectories.

[2] Following my question [1], should I assume we're not making any index.md directories for C++ directories?

I would modify the examples/index.md file with a bit of description of the directory tree. For instance, that we organize examples by PDE-type and then by dimensionality.

[3] Would it be better if I added that description under Readme? For the Sphinx, we will be adding the index below the README, so both files will be served on the examples homepage.

[pritkc]

@valeriabarra This branch has been tested and is ready for your review.
Changes from the last post review :

1. Retained the original directory structure of matlab and C++ API examples
2. Moved the examples-doc inside the Sphinx
3. Added new examples; now each category has at least one example for it.
4. Repaired the linker references; now they link to their master GH repo
5. Improved the TOC tree structure for better visibility of sections.
6. Tested and rebased up to date with the master

Pending --

1. Pre-merger squash, there are no isolated commit requirements for this work. You may squash everything if no further improvements are needed.

[pritkc]

Will close #135 as well

[pritkc]

@valeriabarra The above feedback and the duplicate graphviz have been taken care of with this last push.

[valeriabarra]

Excellent job, @pritkc !!