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

Work out how to host docs for individual tools #4

Open
adamltyson opened this issue May 17, 2023 · 0 comments
Open

Work out how to host docs for individual tools #4

adamltyson opened this issue May 17, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@adamltyson
Copy link
Member

Ideally we want:
a) Tool-specific docs to be part of the relevant repo so that docs can be updated along with code (and autogenerated API docs)
b) All docs to be accessible via one site (brainglobe.info)

How do we do this? I haven't found any tool to automate this, the best way seems to be some kind of custom build script. The process could be something like:

  • Include docs in all repos
  • Have a central repo (this one) which contains general BrainGlobe info, and a script to:
    • Find all repos with docs
    • Copy files
    • Build one large site with all appropriate links

Any ideas @alessandrofelder? We should think about this as we start to accumulate more documentation for different parts of the project.

@adamltyson adamltyson added documentation Improvements or additions to documentation enhancement New feature or request labels May 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Backlog
Development

No branches or pull requests

1 participant