Comments (13)
I agree with you. I think that it would be better to prepare gh-pages and put a link to scaladoc on it at the first.
After that, tutorials also should be written. In this weekend, I will prepare gh-pages and put the link to scaladoc probably.
from nscala-time.
There are sbt plugins for documentation
- https://github.com/sbt/sbt-site
- https://github.com/jsuereth/xsbt-ghpages-plugin
- https://github.com/sbt/sbt-ghpages
from nscala-time.
There are sbt plugins for documentation
Thanks. I try to use and compare these plugins.
from nscala-time.
If you only want to automate the process of generating documents, using sbt-plugin is not a good idea.
I think it's good enough to write some shell scripts or something like that.
We should keep the build process simple as possible for someone who will participate this project.
from nscala-time.
We should keep the build process simple as possible for someone who will participate this project.
I agree with this statement. However, I don't understand enough the folowing statement:
If you only want to automate the process of generating documents, using sbt-plugin is not a good idea.
Although it's enough to write shell scripts to automate the process of generating documents certainly,
it seems that build process by only putting the following command is simple enough (with
sbt-ghpages and sbt-site plugin) :
$ sbt ghpages-push-site
from nscala-time.
I' m worrying that someone who doesn't know much about sbt will be in trouble.
But these plugins seem to be well maintained and have no problem. I agree to use them now.
from nscala-time.
OK. I see your point. Since sbt-ghpages and sbt-site seem to be well maintained for me, too, I try to use it for documentation.
from nscala-time.
I should start to create a website for documents any time now.
from nscala-time.
👍
from nscala-time.
Any update ?
from nscala-time.
@Nelrohd Sorry for waiting. Since I've just published nscala-time 0.4.0, I'll start to create a website for documents from today.
from nscala-time.
@Nelrohd I started to create a website for documents from now using sbt-site and sbt-gh-pages plugin. Currently, only latest nscala-time scaladoc API references are available. I'll update nscala-time site using sbt-site's jekyll-site-generation feature with bootstrap.
from nscala-time.
here is the latest scaladoc.
closing for now because nobody commented in this issue for a long time.
from nscala-time.
Related Issues (20)
- Latest Version publish HOT 1
- Drop Scala 2.9.3 support in newer version HOT 1
- Conversion from Interval to FiniteDuration HOT 4
- max min to DateTime HOT 3
- Add support for multiplication of constant with duration HOT 1
- Check if date is within time range
- RichLong is missing timezone-aware helpers
- Release for Scala 2.12.0 HOT 1
- Possible improvement: DateTime + FiniteDuration syntax
- Get weird result when I want to find period between two dates and subtract some date by it HOT 1
- Release with the latest joda HOT 1
- API changes report for Nscala Time
- Unexpected behaviour with setting DateTime to Midnight HOT 2
- Possible improvement: add the ability to exclude the end of the interval when splitting by period
- Where can I find current release notes?
- Reasons behind now() change? HOT 1
- What do you think about implicit toDateTime over long HOT 1
- New released needed for JDK 1.8u60 HOT 2
- Migrate to java.time HOT 1
- support for min / max operations HOT 1
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 nscala-time.