Skip to content

Split docu in repos#8

Merged
jdsika merged 5 commits intomasterfrom
split-docu-in-repos
Oct 24, 2019
Merged

Split docu in repos#8
jdsika merged 5 commits intomasterfrom
split-docu-in-repos

Conversation

@vkresch
Copy link
Copy Markdown
Collaborator

@vkresch vkresch commented Oct 24, 2019

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

  • I have performed a self-review of my own code/documentation.
  • My documentation changes are related to every repo in the OSI organization.
  • My changes generate no new warnings during the documentation generation.
  • The existing travis ci which pushes the documentation to gh-pages passes with my changes.

Copy link
Copy Markdown
Contributor

@jdsika jdsika left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can merge after quickly answering my questions here, please

Comment thread .travis.yml
- 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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
Collaborator Author

@vkresch vkresch Oct 24, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for now osi-validation also needs the folder

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is how the docu will look like after merging. The READMEs are now the entry point of each topic like discussed.

Comment thread conf.py
@@ -101,8 +102,11 @@
'.github',
'osi-validation/open-simulation-interface',
'osi-validation/proto2cpp',
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not understand this as well

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@jdsika jdsika added documentation Everything which impacts the quality of the documentation and guidelines. quality Quality improvements. labels Oct 24, 2019
@jdsika jdsika merged commit 7da86da into master Oct 24, 2019
@vkresch vkresch deleted the split-docu-in-repos branch February 12, 2020 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Everything which impacts the quality of the documentation and guidelines. quality Quality improvements.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Centralized documentation repository conflicts with separate versioning

2 participants