Comments (11)
Maybe Adam's new documentation generator is worth looking at.
Have you build something with Adam's docs?
from mir.
Nope, was just an idea. However I have done this Travis to s3 many times, so if you have a favorite doc generator, I would be happy to hack something together next week.
On March 31, 2016 5:44:25 PM GMT+03:00, Ilya Yaroshenko [email protected] wrote:
Maybe Adam's new documentation generator is worth looking at.
Have you build something with Adam's docs?
You are receiving this because you authored the thread.
Reply to this email directly or view it on GitHub:
#32 (comment)
from mir.
Nope, was just an idea. However I have done this Travis to s3 many times, so if you have a favorite doc generator, I would be happy to hack something together next week.
I like https://github.com/kiith-sa/harbored-mod and Adam's doc engine looks good too. Mir requires all DDOC macros from Phobos. This will add some problems.
from mir.
Mir requires all DDOC macros from Phobos. This will add some problems.
Hmm yeah this is going to be tricky, but maybe taking the macro definition from the dlang.org repo is already enough.
I am more worried about references to Phobos modules, so when using REF the link won't resolve, but perhaps as a workaround a simple regex could find these occurrences
An alternative would be to use the setup from dlang.org, but modified to only build Mir.
The advantages here is that we avoid ui bugs due to different documentation engines if a module will be merged to Phobos and their css design is pretty sweet.
On March 31, 2016 5:58:11 PM GMT+03:00, Ilya Yaroshenko [email protected] wrote:
Nope, was just an idea. However I have done this Travis to s3 many
times, so if you have a favorite doc generator, I would be happy to
hack something together next week.I like https://github.com/kiith-sa/harbored-mod and Adam's doc engine
looks good too. Mir requires all DDOC macros from Phobos. This will add
some problems.
You are receiving this because you authored the thread.
Reply to this email directly or view it on GitHub:
#32 (comment)
from mir.
as bootDoc
is working again - do you want to add that back to the Readme?
Btw should we archive every documentation version? We could just execute the s3 copy
command to the git describe --abbrev=0 --tags
(latest tag) too, but then we should probably provide a nice way for the user to switch between documentations and at the moment we didn't introduce any breaking changes - so just an idea once the first official version is released.
from mir.
as bootDoc is working again - do you want to add that back to the Readme?
We still need to add macros like LREF and others.
from mir.
Btw should we archive every documentation version? We could just execute the s3 copy command to the git describe --abbrev=0 --tags (latest tag) too, but then we should probably provide a nice way for the user to switch between documentations and at the moment we didn't introduce any breaking changes - so just an idea once the first official version is released.
This would be helpful
from mir.
After testing ddox, bootDoc, harbored-mod I gave@adamdruppe's new adrdox a try:
http://docs.mir.dlang.io/adrdox/mir.combinatorics.html
It's still in an experimental stage, but I really like the fact how easy it is to give it a custom skeleton :)
from mir.
Looks good
from mir.
I like https://github.com/kiith-sa/harbored-mod and Adam's doc engine looks good too
Seems like harbored is working again.
I gave it a try too: http://docs.mir.dlang.io/harbored/
from mir.
Fixed with #203
from mir.
Related Issues (20)
- Special optimization for compile time known kernels HOT 1
- Separable filters support for DCV HOT 1
- Package mir contains invalid dependency cpuid (ci=1) HOT 5
- libmir.so missing from .gitignore HOT 1
- cannot infer argument types, expected 1 argument, not 2 in opApply on Slice HOT 2
- auto a=[[1,2],[3,4]].ndarray; // how to do that? (doens't compile) HOT 3
- Error: cannot append type int[] to type Slice!(2LU, int*) HOT 2
- mir vs ndslice conflict in dmd vs ldc when compiling with dub on ubuntu HOT 2
- Tiny Mersenne Twister HOT 1
- regression test to make sure at least latest dub versions work? currently broken HOT 1
- dot, norm, asum to mir.math.sum HOT 1
- mir-random does not compile with latest ldc on raspberry pi HOT 4
- How to reference the library HOT 6
- FFT? HOT 1
- OpenCL implementation? HOT 1
- can't understand how `sliced` definition compiles HOT 3
- Failing on Buildkite HOT 3
- rand!float() exponent problem HOT 3
- mir-algorithm dependency fails to build because of mir-core with ldc2 and gdc HOT 4
- Deprecation warnings
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from mir.