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.

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

Update model docs to reStructuredText format #1374

Closed

Conversation

jessica-mitchell
Copy link
Contributor

This PR stems from the user doc extractor from @jougs and @terhorstd (Note #1355 probably should be merged first)

It removes the doxygen style format and replaces it with reStructuredText in the models/ directory.
I also removed the SLI examples.

Note that now we've lost the automated linking (like in the See Also section) that breathe used to do.

see the current output here: https://nest-test.readthedocs.io/en/update_models_rst_format/from_cpp/index.html

@terhorstd terhorstd requested a review from jougs January 6, 2020 11:17
@terhorstd terhorstd added ZC: Documentation DO NOT USE THIS LABEL I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) ZP: PR Created DO NOT USE THIS LABEL S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. labels Jan 6, 2020
@terhorstd terhorstd added this to the NEST 3.0 milestone Jan 6, 2020
@jougs
Copy link
Contributor

jougs commented Jan 11, 2020

@jessica-mitchell: I had a meeting with @sarakonradi yesterday, discussing what I would like to have changed in this one and we agreed that she will make the changes and send you a corresponding PR instead of me doing a review at this point. Once that happened, I'll have another closer look.

@jougs
Copy link
Contributor

jougs commented Feb 13, 2020

Can you please pull upstream/master again? Since the merge of #1245, there's a new MUSIC proxy whose documentation also needs conversion to RST. Thanks!

…t" PR to the status of documentation content per nest#1396.
@heplesser
Copy link
Contributor

@jessica-mitchell I just sent you a PR towards your branch to resolve the merge conflict.

Update documentation of iaf_chxk_2008 in model rst branch
@heplesser
Copy link
Contributor

@jessica-mitchell This did not work quite as well as I had hope. Note that the iaf_chxk_2008 model has moved to the precise directory per #1396. Could you pull the most recent master into your branch? We can then sort out the model documentation to make sure that your changes to formatting and my changes to content get nicely combined.

@sarakonradi
Copy link
Contributor

@heplesser The MUSIC proxy documentation also needs to be converted to RST. I assume that, once the iaf_chxk_2008 merge conflict is solved, we will send a separate PR to @jessica-mitchell?

@jessica-mitchell
Copy link
Contributor Author

@heplesser @sarakonradi Merged master, seems like conflicts are gone :)

@sarakonradi
Copy link
Contributor

#1484 updates the rate-based models' documentation and should be taken into account.

@heplesser
Copy link
Contributor

#1484 updates the rate-based models' documentation and should be taken into account.

@jessica-mitchell #1484 is merged into master now, so you could pull it directly in here. This may explain the new merge conflicts.

@sarakonradi
Copy link
Contributor

Yes @heplesser, that definitely explains the new merge conflicts.

We should make sure the rate-based models and MUSIC proxy files are properly converted to RST given the recent updates (#1484, #1245).

@heplesser heplesser removed ZC: Documentation DO NOT USE THIS LABEL ZP: PR Created DO NOT USE THIS LABEL labels Apr 7, 2020
@sarakonradi
Copy link
Contributor

sarakonradi commented Apr 20, 2020

@jougs I discussed this PR with @terhorstd in our recent doc meeting. We thought that, other than fixing the merge conflicts, it might make more sense to bring #1374 to an end soon and to address the improvement of the MUSIC proxy and rate-based models in a follow-up PR straight afterwards. What do you think?

Otherwise, I am happy sending another PR to @jessica-mitchell!

@heplesser
Copy link
Contributor

@sarakonradi I think disentangling PRs is a good idea. Release early, release often, as they say in the agile world ;).

@heplesser
Copy link
Contributor

Closed, replaced by #1530.

@heplesser heplesser closed this Apr 22, 2020
@jessica-mitchell jessica-mitchell deleted the update_models_rst_format branch March 30, 2021 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants