Skip to content

Commit

Permalink
Removes all doc website related stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
davesmith00000 committed Nov 3, 2024
1 parent 8563747 commit 97c334b
Show file tree
Hide file tree
Showing 124 changed files with 4 additions and 8,522 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ How to report via the [issue tracker](https://github.com/PurpleKingdomGames/indi

## Updating documentation

Game engines are complicated, especially for new people, and so are only as good as their documentation. If you like to help update our docs, please raise a Pull Request against the [documentation website repo](https://github.com/PurpleKingdomGames/indigo-website).
Game engines are complicated, especially for new people, and so are only as good as their documentation. If you like to help update our docs, please raise a Pull Request against the [documentation website repo](https://github.com/PurpleKingdomGames/indigo-docs).

## Writing code for Indigo

Expand Down
75 changes: 2 additions & 73 deletions indigo/build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,6 @@ ThisBuild / scalafixDependencies += "com.github.liancheng" %% "organize-imports"
ThisBuild / scalaVersion := scala3Version

lazy val indigoVersion = IndigoVersion.getVersion
// For the docs site
lazy val indigoDocsVersion = "0.17.0"
lazy val tyrianDocsVersion = "0.11.0"
lazy val scalaJsDocsVersion = "1.16.0"
lazy val scalaDocsVersion = "3.4.1"
lazy val sbtDocsVersion = "1.9.9"
lazy val millDocsVersion = "0.11.7"

lazy val commonSettings: Seq[sbt.Def.Setting[_]] = Seq(
version := indigoVersion,
Expand Down Expand Up @@ -61,22 +54,14 @@ lazy val publishSettings = {
// Root
lazy val indigoProject =
(project in file("."))
.enablePlugins(ScalaJSPlugin, ScalaUnidocPlugin)
.enablePlugins(ScalaJSPlugin)
.settings(
neverPublish,
commonSettings,
name := "IndigoProject",
code := codeTaskDefinition,
usefulTasks := customTasksAliases,
presentationSettings(version),
ScalaUnidoc / unidoc / unidocProjectFilter := inAnyProject -- inProjects(
tyrianIndigoBridge, // TODO: After next release (>0.15.2), try removing tyrianIndigoBridge from unidoc filter
sandbox,
perf,
shader,
physics,
docs
)
presentationSettings(version)
)
.aggregate(
indigo,
Expand All @@ -87,7 +72,6 @@ lazy val indigoProject =
perf,
shader,
physics,
docs,
benchmarks,
tyrianSandbox
)
Expand Down Expand Up @@ -269,61 +253,6 @@ lazy val benchmarks =
jsDependencies ++= Dependencies.benchmarkJs.value
)

lazy val jsdocs = project
.settings(
neverPublish,
organization := "io.indigoengine",
libraryDependencies ++= Dependencies.jsDocs.value,
libraryDependencies ++= Seq(
"io.indigoengine" %%% "indigo-json-circe" % indigoDocsVersion,
"io.indigoengine" %%% "indigo" % indigoDocsVersion,
"io.indigoengine" %%% "indigo-extras" % indigoDocsVersion,
"io.indigoengine" %%% "tyrian-io" % tyrianDocsVersion,
"io.indigoengine" %%% "tyrian-indigo-bridge" % indigoDocsVersion
),
Compile / tpolecatExcludeOptions ++= Set(
ScalacOptions.warnValueDiscard,
ScalacOptions.warnUnusedImports,
ScalacOptions.warnUnusedLocals
)
)
.enablePlugins(ScalaJSPlugin)

lazy val docs = project
.in(file("indigo-docs"))
.enablePlugins(MdocPlugin)
.settings(
neverPublish,
organization := "io.indigoengine",
mdocJS := Some(jsdocs),
mdocExtraArguments := List("--no-link-hygiene"),
mdocVariables := Map(
"VERSION" -> indigoDocsVersion,
"SCALAJS_VERSION" -> scalaJsDocsVersion,
"SCALA_VERSION" -> scalaDocsVersion,
"SBT_VERSION" -> sbtDocsVersion,
"MILL_VERSION" -> millDocsVersion,
"js-opt" -> "fast"
),
Compile / tpolecatExcludeOptions ++= Set(
ScalacOptions.warnValueDiscard,
ScalacOptions.warnUnusedImports,
ScalacOptions.warnUnusedLocals
)
)
.settings(
run / fork := true
)

addCommandAlias(
"gendocs",
List(
"cleanAll",
"unidoc", // Docs in ./target/scala-3.3.1/unidoc/
"docs/mdoc" // Docs in ./indigo/indigo-docs/target/mdoc
).mkString(";", ";", "")
)

addCommandAlias(
"tyrianSandboxBuild",
List(
Expand Down
11 changes: 0 additions & 11 deletions indigo/commands.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,6 @@ def applyCrossToAllReleaseable(command: String): String =
applyCrossCommand(releaseProjects, command)
).mkString

// Rebuild ScalaDocs and open in Firefox
addCommandAlias(
"readdocs",
applyCommand(coreProjects, "doc") +
List(
"openshareddocs",
"openindigodocs",
"openindigoextsdocs"
).mkString(";", ";", "")
)

addCommandAlias(
"cleanAll",
applyToAll("clean")
Expand Down
1 change: 0 additions & 1 deletion indigo/docs/01-quickstart/directory.conf

This file was deleted.

57 changes: 0 additions & 57 deletions indigo/docs/01-quickstart/examples.md

This file was deleted.

31 changes: 0 additions & 31 deletions indigo/docs/01-quickstart/extensions-and-libs.md

This file was deleted.

Loading

0 comments on commit 97c334b

Please sign in to comment.