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

Synchronizing Birdhouse and PAVICS Documentations #17

Open
Zeitsperre opened this issue Feb 19, 2018 · 6 comments
Open

Synchronizing Birdhouse and PAVICS Documentations #17

Zeitsperre opened this issue Feb 19, 2018 · 6 comments

Comments

@Zeitsperre
Copy link
Contributor

As was discussed, we should be trying to flesh out the documentation of Birdhouse with common elements in pavics-sdi. I'm currently reading through both documentations and familiarizing myself with sphinx libraries. Issue discussion at pavics-sdi can be found here: Ouranosinc/pavics-sdi#15

@Zeitsperre Zeitsperre changed the title Synchornizing Birdhouse and PAVICS Documentations Synchronizing Birdhouse and PAVICS Documentations Feb 19, 2018
@cehbrecht cehbrecht added this to the 0.5.0 milestone Mar 28, 2018
@cehbrecht cehbrecht modified the milestones: 0.5.0, 0.6.0 Apr 5, 2018
@nilshempelmann
Copy link
Member

To respect and promote the Projects here is a section for it now:
https://birdhouse.readthedocs.io/en/latest/projects.html

Former section "projects" is renamed to 'components'

@cehbrecht cehbrecht modified the milestones: 0.6.0, 0.7.0 Sep 14, 2018
@nilshempelmann
Copy link
Member

@huard @cehbrecht
The FP processes documentation is updated and can be used as reference in Pavics.

I suggest to move (and adopt) the Pavics tutorial to the Birdhouse Documentation.

@nilshempelmann
Copy link
Member

@huard as suggested by @cehbrecht there is now a notebook repository https://github.com/bird-house/notebooks. Right place for tutorials

@nilshempelmann
Copy link
Member

nilshempelmann commented Feb 1, 2019

@huard As discussed at last VC here a 'roadmap' or suggestion of what should be documented where:

  • Birdhouse Top-level documentaion : General aspects like principals, publications, guidlines, coding style and general tutorials
  • birds and modules: module specific information, process methodes, additions to the linked general documentation (the cookycutter should provide the appropriate links to the top-level documentation)
  • project docs: Project specific Information. User related tutorial and explanaiton. I see Project docs User orientated, while Birdhouse docs are developer orientated

@Zeitsperre
Copy link
Contributor Author

@huard with #44 Are we good to close this issue?

@huard
Copy link
Contributor

huard commented Oct 29, 2019

I think the last step would be to configure subprojects inside birdhouse to include documentation from individual birds in the search index.

@cehbrecht cehbrecht removed this from the 0.9.0 milestone Apr 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants