Merge: Move back manual to the main repo
authorJean Privat <jean@pryen.org>
Mon, 15 Jul 2019 15:07:28 +0000 (11:07 -0400)
committerJean Privat <jean@pryen.org>
Mon, 15 Jul 2019 15:07:28 +0000 (11:07 -0400)
The manual is slowly bit rotting in the wiki (the disclaimer in http://nitlanguage.org/manual/ and the link to the very old issue  #761 is not a nice thing to have).

The idea is to move back the documentation in the main repository so that PR that enhance the language should also update the manual.
We could add checks to ensure that new AST element or annotations implies some update in the manual.

It is what is currently done with the manpages of the tools, and they are quite complete and up to date.

Pull-Request: #2762

1  2 
.gitlab-ci.yml

diff --combined .gitlab-ci.yml
@@@ -358,6 -358,16 +358,16 @@@ build_doc
      paths:
        - nitdoc.out
  
+ build_manual:
+   stage: more_test
+   script:
+     - apt-get update && apt-get install --yes --no-install-recommends pandoc texlive texlive-latex-extra lmodern
+     - make -C doc/manual
+   artifacts:
+     paths:
+       - doc/manual/*.pdf
+       - doc/manual/*.epub
  nitmetrics:
    stage: more_test
    dependencies:
@@@ -379,6 -389,8 +389,6 @@@ build_catalog
      - ./oot.sh pre-build
      - cd ..
      - nitcatalog -d catalog.out lib/ examples/ contrib/ contrib/oot/
 -  dependencies:
 -    - build_more_tools
    artifacts:
      paths:
        - catalog.out
@@@ -401,14 -413,3 +411,14 @@@ test_full_nitcs_macos
      - macos
    dependencies:
      - build_tools_macos
 +
 +bench_old:
 +  stage: more_test
 +  tags:
 +    - perf
 +  dependencies:
 +    - build_tools
 +  script:
 +    - benchmarks/bench_old.sh
 +  allow_failure: true # time is unreliable. manual check required
 +  services: []