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

adding docs #41

Open
stevevanhooser opened this issue Sep 15, 2021 · 0 comments
Open

adding docs #41

stevevanhooser opened this issue Sep 15, 2021 · 0 comments
Assignees

Comments

@stevevanhooser
Copy link
Contributor

Let's add documentation to the distribution.

Katherine -

I just made a new branch called "docs". It has a file "+mia/+docs/build.m" that I copied directly from vhlab-toolbox-matlab. It needs to be modified a bit so that it corresponds to our package here. One thing that does not correspond is the method for finding the path of the distribution. vhlab-arraytomography-matlab does not have a set of global variables (yet).
So I would find the distribution with:

w = which('mia.docs.build');
[parentdir,fname]= fileparts(w);
[parentparent,fname2] = fileparts(parentdir);
[parentparentparent,fname3] = fileparts(parentparent);

% parentparentparent is the path

The rest of the build file needs little modification. We have basic tools in vlt.docs that build a documentation site like http://vlt.vhlab.org.

There also needs some editing to be done to change the template files in docs:
mkdocs-start.yml has the details of the repo, and index.md, contributing.md, and installation.md should be slightly updated.

If you get stuck, let me know, either by writing here or slack or email.

Thanks!
Steve

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants