Conversation
jdsika
left a comment
There was a problem hiding this comment.
You can merge after quickly answering my questions here, please
| - git clone https://github.com/OpenSimulationInterface/open-simulation-interface.git | ||
| - git clone https://github.com/OpenSimulationInterface/proto2cpp.git | ||
| - git clone https://github.com/OpenSimulationInterface/osi-sensor-model-packaging.git | ||
| - cd osi-validation |
There was a problem hiding this comment.
I do not understand this step here:
- you clone osi twice? does the osi-validation need the module itself. I thought it should be more something like:
git clone osi
cd osi
make install
-> osi-validation is now able to find the package because it was installed?
There was a problem hiding this comment.
I make two clones of osi one in osi-documentation/open-simulation-interface and one in osi-documentation/osi-validation/open-simulation-interface. The first clone is used to parse the docu and the second one is used by osi-validation and to install osi. I could change the paths in index.rst to osi-validation/open-simulation-interface/doc/*.rst and get rid of the first cloning but I thought the paths open-simulation-interface/doc/*.rst are more consistent according to the other repos. I could be wrong. Maybe the multiple cloning is more confusing.
There was a problem hiding this comment.
for now osi-validation also needs the folder
There was a problem hiding this comment.
Here is how the docu will look like after merging. The READMEs are now the entry point of each topic like discussed.
| @@ -101,8 +102,11 @@ | |||
| '.github', | |||
| 'osi-validation/open-simulation-interface', | |||
| 'osi-validation/proto2cpp', | |||
There was a problem hiding this comment.
I do not understand this as well
There was a problem hiding this comment.
I exclude these folders so they don't get parsed by sphinx. Sphinx throws warning when it finds any *.md file which is not used.
Reference to a related issue in the repository
This PR fulfills the requirement from here.
resolves #7
Add a description
This PR gets rid of the docu folders of each repo in the OSI organization. For now there is only a parsing of the docu from each cloned repo.
Mention a member
@pmai @jdsika pls review :)
Check the checklist