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

[WIP] build pkgs documentation with DemoCards #159

Draft
wants to merge 1 commit into
base: source
Choose a base branch
from
Draft

Conversation

johnnychen94
Copy link
Member

This is still a WIP PR; it requires the master branch of DemoCards.

The idea is to move docs/src/pkgs to docs/pkgs and build it with DemoCards, this enables us to collect remote documentation in sub packages (e.g., ImageFiltering), and furthermore, we could gradually move the current pkgs docs back to their repo.

This is the new folder structure, note that docs/pkgs/config.json is added for order specification:

docs
├── examples
│   ├── color_channels
│   ├── config.json
│   ├── contours
│   ├── image_quality_and_benchmarks
│   ├── index.md
│   └── spatial_transformation
├── make.jl
├── pkgs
│   ├── axes
│   ├── config.json
│   ├── features
│   ├── introduction
│   ├── metadata
│   ├── segmentation
│   └── transformations
└── src
    ├── api_comparison.md
    ├── assets
    ├── function_reference.md
    ├── index.md
    ├── install.md
    └── tutorials

@ashwani-rathee
Copy link
Member

I think I could help with this,I think it needs a lot of rewriting and changing but democards.jl will be much better option.How can I help?

@johnnychen94
Copy link
Member Author

I still don't have a clean and clear view of what changes we should do here until I finished JuliaDocs/DemoCards.jl#72

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

Successfully merging this pull request may close these issues.

2 participants