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.

Sign up for GitHub

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

Jump to bottom

Add documentation for micro-manager installation #270

Merged
merged 11 commits into from
May 30, 2023
Merged

Add documentation for micro-manager installation #270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
dbfc42c
Add initial documentation for micro-manager
erikscheurer Apr 23, 2023
7ebc03b
Merge branch 'precice:master' into micro-manager-installation
erikscheurer May 8, 2023
557ca2c
Move micro manager to submodule and tooling
erikscheurer May 12, 2023
c8d7215
Restructure Micro Manager documentation
erikscheurer May 19, 2023
2248959
Update sidebar for micromanager
erikscheurer May 19, 2023
bd7d0d5
Add overview page
erikscheurer May 19, 2023
60e5351
Merge branch 'master' into micro-manager-installation
IshaanDesai May 25, 2023
64429b1
Add .git ending to Micro Manager GitHub repo link
IshaanDesai May 26, 2023
02a53b1
Add branch to micro-manager link in .gitmodules
IshaanDesai May 26, 2023
ffa1cef
Remove `Usage` page from sidebar
erikscheurer May 26, 2023
aa4f954
Update commit for the micro-manager
erikscheurer May 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,7 @@
path = imported/aste
url = https://github.com/precice/aste.git
branch = develop
[submodule "imported/micro-manager"]
path = imported/micro-manager
url = https://github.com/precice/micro-manager.git
Comment on lines 10 to +15
Copy link
Member

Choose a reason for hiding this comment

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

Why no branch for the micro-manager here?
I guess the workflow is failing because the pages don't yet exist in the default branch (main): https://github.com/precice/micro-manager/tree/main/docs

       Subproject: imported/openfoam-adapter/docs
      Adding pages: README.md, openfoam-support.md, config.md, get.md, extend.md
         Tutorials: No subproject found at imported/micro-manager/docs
        Subproject: imported/micro-manager/docs
                    ------------------------------------------------
      Jekyll 4.2.2   Please append `--trace` to the `build` command 
                     for any additional information or backtrace. 
                    ------------------------------------------------
/home/runner/work/precice.github.io/precice.github.io/website/_plugins/subprojects.rb:22:in `block in generate': No subproject found at imported/micro-manager/docs (RuntimeError)

Copy link
Member

Choose a reason for hiding this comment

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

Thanks for noticing this! The website building still fails, but this was definitely an issue.

Copy link
Member

Choose a reason for hiding this comment

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

I don't know, but I am confused by this line:

Tutorials: No subproject found at imported/micro-manager/docs

Where should the Tutorials: come from?

branch = develop
13 changes: 13 additions & 0 deletions _config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,18 @@ defaults:
topnav: topnav
toc: true
github_editme_path: https://github.com/precice/aste/edit/develop/ # ends in /
-
scope:
path: "imported/micro-manager/"
type: "pages"
values:
layout: "page"
comments: false
search: true
sidebar: docs_sidebar
topnav: topnav
toc: true
github_editme_path: https://github.com/precice/micro-manager/edit/develop/ # ends in /
-
scope:
path: "pages/community"
Expand Down Expand Up @@ -214,6 +226,7 @@ subprojects:
- imported/tutorials/channel-transport-reaction
- imported/tutorials/aste-turbine
- imported/openfoam-adapter/docs
- imported/micro-manager/docs
- imported/aste/docs

# We use these versions to centrally update links
Expand Down
25 changes: 25 additions & 0 deletions _data/sidebars/docs_sidebar.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,31 @@ entries:
url: /tooling-rbf-shape.html
output: web, pdf

subfolders:
- title: Micro Manager
output: web, pdf
subfolderitems:

- title: Overview
url: /tooling-micro-manager-overview.html
output: web, pdf

- title: Installation
url: /tooling-micro-manager-installation.html
output: web, pdf

- title: Code Changes
url: /tooling-micro-manager-usage-code-changes.html
output: web, pdf

- title: Configuration
url: /tooling-micro-manager-usage-configuration.html
output: web, pdf

- title: Running
url: /tooling-micro-manager-usage-running.html
output: web, pdf

- title: Provided adapters
output: web, pdf
folderitems:
Expand Down
1 change: 1 addition & 0 deletions imported/micro-manager
Open in desktop
Submodule micro-manager added at e9540c