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

Scaladoc markdown preprocessor #13140

Merged
merged 6 commits into from
Oct 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 20 additions & 5 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -470,9 +470,12 @@ jobs:
if: "(github.event_name == 'schedule' || github.event_name == 'workflow_dispatch') && github.repository == 'lampepfl/dotty'"
env:
NIGHTLYBUILD: yes
BOT_TOKEN: ${{ secrets.BOT_TOKEN }} # If you need to change this:
# Generate one at https://github.com/settings/tokens
# Make sure you have the write permissions to the repo: https://github.com/lampepfl/dotty-website
DOTTY_WEBSITE_BOT_TOKEN: ${{ secrets.BOT_TOKEN }} # If you need to change this:
julienrf marked this conversation as resolved.
Show resolved Hide resolved
# Generate one at https://github.com/settings/tokens
# Make sure you have the write permissions to the repo: https://github.com/lampepfl/dotty-website
DOCS_SCALALANG_BOT_TOKEN: ${{ secrets.DOCS_SCALALANG_BOT_TOKEN }} # If you need to change this:
julienrf marked this conversation as resolved.
Show resolved Hide resolved
# Generate one at https://github.com/settings/tokens
# Make sure you have the write permissions to the repo: https://github.com/scala/docs.scala-lang

steps:
- name: Reset existing repo
Expand All @@ -494,14 +497,26 @@ jobs:
run: |
./project/scripts/genDocs -doc-snapshot

- name: Deploy Website
- name: Deploy Website to dotty-website
uses: peaceiris/actions-gh-pages@v3
with:
personal_token: ${{ secrets.BOT_TOKEN }}
personal_token: ${{ env.DOTTY_WEBSITE_BOT_TOKEN }}
publish_dir: docs/_site
external_repository: lampepfl/dotty-website
publish_branch: gh-pages

- name: Generate docs.scala-lang preprocessed files
run: |
./project/scripts/genDocsScalaLang

- name: Deploy Website to docs.scala-lang
uses: peaceiris/actions-gh-pages@v3
with:
personal_token: ${{ env.DOCS_SCALALANG_BOT_TOKEN }}
publish_dir: docsScalaLang
external_repository: BarkingBad/docs.scala-lang
publish_branch: dev
julienrf marked this conversation as resolved.
Show resolved Hide resolved

publish_release:
runs-on: [self-hosted, Linux]
container:
Expand Down
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -105,3 +105,7 @@ compiler/test-coursier/run/*.jar

# Docs
docs-for-dotty-page/*

# docs.scala-lang deplyment temp dir
docsScalaLang/
docs/_site/
4 changes: 2 additions & 2 deletions docs/docs/reference/changed-features.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Other Changed Features"
type: chapter
num: 51
previous-page: /scala3/reference/other-new-features/type-test
num: 52
previous-page: /scala3/reference/other-new-features/experimental-defs
next-page: /scala3/reference/changed-features/numeric-literals
---

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/changed-features/compiler-plugins.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Changes in Compiler Plugins"
type: section
num: 67
num: 68
previous-page: /scala3/reference/changed-features/eta-expansion
next-page: /scala3/reference/changed-features/lazy-vals-init
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/changed-features/eta-expansion.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Automatic Eta Expansion"
type: section
num: 66
num: 67
previous-page: /scala3/reference/changed-features/pattern-matching
next-page: /scala3/reference/changed-features/compiler-plugins
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Implicit Conversions"
type: section
num: 60
num: 61
previous-page: /scala3/reference/changed-features/implicit-resolution
next-page: /scala3/reference/changed-features/overload-resolution
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Changes in Implicit Resolution"
type: section
num: 59
num: 60
previous-page: /scala3/reference/changed-features/type-inference
next-page: /scala3/reference/changed-features/implicit-conversions
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/changed-features/imports.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Imports"
type: section
num: 56
num: 57
previous-page: /scala3/reference/changed-features/wildcards
next-page: /scala3/reference/changed-features/type-checking
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/changed-features/lazy-vals-init.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Lazy Vals Initialization
type: section
num: 68
num: 69
previous-page: /scala3/reference/changed-features/compiler-plugins
next-page: /scala3/reference/changed-features/main-functions
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/changed-features/main-functions.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Main Methods"
type: section
num: 69
num: 70
previous-page: /scala3/reference/changed-features/lazy-vals-init
next-page: /scala3/reference/dropped-features
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/changed-features/match-syntax.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Match Expressions"
type: section
num: 62
num: 63
previous-page: /scala3/reference/changed-features/overload-resolution
next-page: /scala3/reference/changed-features/vararg-splices
---
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/reference/changed-features/numeric-literals.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Numeric Literals"
type: section
num: 52
num: 53
previous-page: /scala3/reference/changed-features
next-page: /scala3/reference/changed-features/structural-types
---

[Document was moved](../experimental/numeric-literals.md)
[Document was moved](../experimental/numeric-literals.md)
2 changes: 1 addition & 1 deletion docs/docs/reference/changed-features/operators.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Rules for Operators"
type: section
num: 54
num: 55
previous-page: /scala3/reference/changed-features/structural-types
next-page: /scala3/reference/changed-features/wildcards
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Changes in Overload Resolution"
type: section
num: 61
num: 62
previous-page: /scala3/reference/changed-features/implicit-conversions
next-page: /scala3/reference/changed-features/match-syntax
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/changed-features/pattern-bindings.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Pattern Bindings"
type: section
num: 64
num: 65
previous-page: /scala3/reference/changed-features/vararg-splices
next-page: /scala3/reference/changed-features/pattern-matching
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/changed-features/pattern-matching.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Option-less pattern matching"
type: section
num: 65
num: 66
previous-page: /scala3/reference/changed-features/pattern-bindings
next-page: /scala3/reference/changed-features/eta-expansion
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/changed-features/structural-types.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Programmatic Structural Types"
type: section
num: 53
num: 54
previous-page: /scala3/reference/changed-features/numeric-literals
next-page: /scala3/reference/changed-features/operators
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/changed-features/type-checking.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Changes in Type Checking"
type: section
num: 57
num: 58
previous-page: /scala3/reference/changed-features/imports
next-page: /scala3/reference/changed-features/type-inference
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/changed-features/type-inference.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Changes in Type Inference"
type: section
num: 58
num: 59
previous-page: /scala3/reference/changed-features/type-checking
next-page: /scala3/reference/changed-features/implicit-resolution
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/changed-features/vararg-splices.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Vararg Splices"
type: section
num: 63
num: 64
previous-page: /scala3/reference/changed-features/match-syntax
next-page: /scala3/reference/changed-features/pattern-bindings
---
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/reference/changed-features/wildcards.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Wildcard Arguments in Types
type: section
num: 55
num: 56
previous-page: /scala3/reference/changed-features/operators
next-page: /scala3/reference/changed-features/imports
---
Expand Down Expand Up @@ -49,4 +49,4 @@ These rules make it possible to cross build between Scala 2 using the kind proje
There is also a migration path for users that want a one-time transition to syntax with `_` as a type parameter placeholder.
With option `-Ykind-projector:underscores` Scala 3 will regard `_` as a type parameter placeholder, leaving `?` as the only syntax for wildcards.

To cross-compile with old Scala 2 sources, while using `_` a placeholder, you must use options `-Xsource:3 -P:kind-projector:underscore-placeholders` together with a recent version of kind-projector (`0.13` and higher) and most recent versions of Scala 2 (`2.13.5` and higher and `2.12.14` and higher)
To cross-compile with old Scala 2 sources, while using `_` a placeholder, you must use options `-Xsource:3 -P:kind-projector:underscore-placeholders` together with a recent version of kind-projector (`0.13` and higher) and most recent versions of Scala 2 (`2.13.5` and higher and `2.12.14` and higher)
2 changes: 1 addition & 1 deletion docs/docs/reference/dropped-features.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Dropped Features"
type: chapter
num: 70
num: 71
previous-page: /scala3/reference/changed-features/main-functions
next-page: /scala3/reference/dropped-features/delayed-init
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/dropped-features/auto-apply.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Dropped: Auto-Application"
type: section
num: 83
num: 84
previous-page: /scala3/reference/dropped-features/symlits
next-page: /scala3/reference/dropped-features/weak-conformance
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/dropped-features/class-shadowing.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Dropped: Class Shadowing"
type: section
num: 79
num: 80
previous-page: /scala3/reference/dropped-features/early-initializers
next-page: /scala3/reference/dropped-features/limit22
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/dropped-features/delayed-init.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Dropped: DelayedInit"
type: section
num: 71
num: 72
previous-page: /scala3/reference/dropped-features
next-page: /scala3/reference/dropped-features/macros
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/dropped-features/do-while.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Dropped: Do-While"
type: section
num: 75
num: 76
previous-page: /scala3/reference/dropped-features/type-projection
next-page: /scala3/reference/dropped-features/procedure-syntax
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/dropped-features/early-initializers.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Dropped: Early Initializers"
type: section
num: 78
num: 79
previous-page: /scala3/reference/dropped-features/package-objects
next-page: /scala3/reference/dropped-features/class-shadowing
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/dropped-features/existential-types.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Dropped: Existential Types"
type: section
num: 73
num: 74
previous-page: /scala3/reference/dropped-features/macros
next-page: /scala3/reference/dropped-features/type-projection
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/dropped-features/limit22.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Dropped: Limit 22"
type: section
num: 80
num: 81
previous-page: /scala3/reference/dropped-features/class-shadowing
next-page: /scala3/reference/dropped-features/xml
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/dropped-features/macros.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Dropped: Scala 2 Macros"
type: section
num: 72
num: 73
previous-page: /scala3/reference/dropped-features/delayed-init
next-page: /scala3/reference/dropped-features/existential-types
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/dropped-features/package-objects.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Dropped: Package Objects"
type: section
num: 77
num: 78
previous-page: /scala3/reference/dropped-features/procedure-syntax
next-page: /scala3/reference/dropped-features/early-initializers
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/dropped-features/procedure-syntax.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Dropped: Procedure Syntax"
type: section
num: 76
num: 77
previous-page: /scala3/reference/dropped-features/do-while
next-page: /scala3/reference/dropped-features/package-objects
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/dropped-features/symlits.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Dropped: Symbol Literals"
type: section
num: 82
num: 83
previous-page: /scala3/reference/dropped-features/xml
next-page: /scala3/reference/dropped-features/auto-apply
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/dropped-features/this-qualifier.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Dropped: private[this] and protected[this]"
type: section
num: 85
num: 86
previous-page: /scala3/reference/dropped-features/weak-conformance
next-page: /scala3/reference/dropped-features/wildcard-init
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/dropped-features/type-projection.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Dropped: General Type Projection"
type: section
num: 74
num: 75
previous-page: /scala3/reference/dropped-features/existential-types
next-page: /scala3/reference/dropped-features/do-while
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/dropped-features/weak-conformance.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Dropped: Weak Conformance"
type: section
num: 84
num: 85
previous-page: /scala3/reference/dropped-features/auto-apply
next-page: /scala3/reference/dropped-features/this-qualifier
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/dropped-features/wildcard-init.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Dropped: Wildcard Initializer"
type: section
num: 86
num: 87
previous-page: /scala3/reference/dropped-features/this-qualifier
next-page: /scala3/reference/syntax
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/dropped-features/xml.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Dropped: XML Literals"
type: section
num: 81
num: 82
previous-page: /scala3/reference/dropped-features/limit22
next-page: /scala3/reference/dropped-features/symlits
---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/language-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Language Versions"
type: chapter
description: This page lists the different flavours of language supported by the Scala 3 compiler.
num: 100
num: 101
previous-page: overview
---

Expand Down
Loading