Giter Site home page Giter Site logo

Comments (13)

kmizu avatar kmizu commented on July 21, 2024

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.

xuwei-k avatar xuwei-k commented on July 21, 2024

There are sbt plugins for documentation

from nscala-time.

kmizu avatar kmizu commented on July 21, 2024

There are sbt plugins for documentation

Thanks. I try to use and compare these plugins.

from nscala-time.

tototoshi avatar tototoshi commented on July 21, 2024

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.

kmizu avatar kmizu commented on July 21, 2024

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.

tototoshi avatar tototoshi commented on July 21, 2024

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.

kmizu avatar kmizu commented on July 21, 2024

@tototoshi

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.

kmizu avatar kmizu commented on July 21, 2024

I should start to create a website for documents any time now.

from nscala-time.

gakuzzzz avatar gakuzzzz commented on July 21, 2024

👍

from nscala-time.

Nelrohd avatar Nelrohd commented on July 21, 2024

Any update ?

from nscala-time.

kmizu avatar kmizu commented on July 21, 2024

@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.

kmizu avatar kmizu commented on July 21, 2024

@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.

xuwei-k avatar xuwei-k commented on July 21, 2024

here is the latest scaladoc.

closing for now because nobody commented in this issue for a long time.

from nscala-time.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.