diff --git a/.github/workflows/make-doc.sh b/.github/workflows/make-doc.sh index e447c3046..f7446f84c 100755 --- a/.github/workflows/make-doc.sh +++ b/.github/workflows/make-doc.sh @@ -12,5 +12,5 @@ chmod 600 "$HOME/.ssh/key" # And upload rsync -avc -e "ssh -i $HOME/.ssh/key -o StrictHostKeyChecking=no -p $SSH_PORT" \ - "$GITHUB_WORKSPACE/doc/" \ + "$GITHUB_WORKSPACE/doc/out/" \ "$SSH_USER@$SSH_HOST:/var/www/tweaked.cc/$DEST" diff --git a/.gitignore b/.gitignore index 63cc1d148..84f17aee8 100644 --- a/.gitignore +++ b/.gitignore @@ -3,9 +3,8 @@ /logs /build /out -/doc/**/*.html +/doc/out/ /doc/javadoc/ -/doc/index.json # Runtime directories /run diff --git a/doc/styles.css b/doc/styles.css index 178e5daf2..a21b9ac34 100644 --- a/doc/styles.css +++ b/doc/styles.css @@ -1,141 +1,9 @@ -/* Basic reset on elements */ -h1, h2, h3, h4, p, table, div, body { - margin: 0; - padding: 0; - border: 0; - font-size: 100%; - font: inherit; - vertical-align: baseline; -} -/* Make the page a little more airy */ -body { - margin: 20px auto; - max-width: 1200px; - padding: 0 10px; - line-height: 1.6; - color: #222; - background: #fff; -} - -/* Try to use system default fonts. */ -body { - font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Fira Sans", - "Droid Sans", "Helvetica Neue", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; -} - -code, pre, kbd, .parameter, .type, .definition-name, .reference-code { - font-family: "SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace; -} - -/* Some definitions of basic tags */ -code { - color: #c7254e; - background-color: #f9f2f4; -} - -p { - margin: 0.9em 0; -} - -h1 { - font-size: 1.5em; - font-weight: lighter; - border-bottom: solid 1px #aaa; -} - -h2, h3, h4 { margin: 1.4em 0 0.3em;} -h2 { font-size: 1.25em; } -h3 { font-size: 1.15em; font-weight: bold; } -h4 { font-size: 1.06em; } - -a, a:visited, a:active { font-weight: bold; color: #004080; text-decoration: none; } -a:hover { text-decoration: underline; } - -blockquote { - padding: 0.3em; - margin: 1em 0; - background: #f0f0f0; - border-left: solid 0.5em #ccc; -} - -/* Stop sublists from having initial vertical space */ -ul ul { margin-top: 0px; } -ol ul { margin-top: 0px; } -ol ol { margin-top: 0px; } -ul ol { margin-top: 0px; } - -/* Make the target distinct; helps when we're navigating to a function */ -a:target + * { background-color: #FFFF99; } - -/* Allow linking to any subsection */ -a[name]::before { content: "#"; } - -/* Layout */ -#main { - display: flex; - flex-wrap: nowrap; - justify-content: space-between; - min-height: calc(100vh - 100px); -} - -#main > nav { - flex-basis: 30%; - min-width: 150px; - max-width: 250px; - background-color: #f0f0f0; -} - -nav h1, nav ul { padding: 0em 10px; } - -nav h2 { - background-color:#e7e7e7; - font-size: 1.1em; - color:#000000; - padding: 5px 10px; -} - -nav ul { - list-style-type: none; - margin: 0; -} - -#content { - flex-shrink: 1; - flex-basis: 80%; - padding: 0px 10px; -} - -footer { - text-align: right; - font-size: 0.8em; -} - -/* The definition lists at the top of each page */ -table.definition-list, table.pretty-table { +/* Pretty tables, mostly inherited from table.definition-list */ +table.pretty-table { border-collapse: collapse; width: 100%; } -table.definition-list td, table.definition-list th { - border: 1px solid #cccccc; - padding: 5px; -} - -table.definition-list th { - background-color: #f0f0f0; - min-width: 200px; - white-space: nowrap; - text-align: right; -} - -/* Deprecated definitions */ -table.definition-list tr.definition-deprecated th { - text-decoration: line-through; -} - -table.definition-list td { width: 100%; } - -/* Pretty tables, mostly inherited from table.definition-list */ table.pretty-table td, table.pretty-table th { border: 1px solid #cccccc; padding: 2px 4px; @@ -144,81 +12,3 @@ table.pretty-table td, table.pretty-table th { table.pretty-table th { background-color: #f0f0f0; } - -dl.definition dt { - border-top: 1px solid #ccc; - padding-top: 1em; - display: flex; -} - -dl.definition dt .definition-name { - padding: 0 0.1em; - margin: 0 0.1em; - flex-grow: 1; -} - -/* Deprecated definitions */ -dl.definition dt .definition-name.definition-deprecated { - text-decoration: line-through; -} - -dl.definition dd { - padding-bottom: 1em; - margin: 10px 0 0 20px; -} - -dl.definition h3 { - font-size: .95em; -} - -/* Links to source-code */ -.source-link { font-size: 0.8em; } -.source-link::before { content: '[' } -.source-link::after { content: ']' } -a.source-link, a.source-link:visited, a.source-link:active { color: #505050; } - -/* Method definitions */ -span.parameter:after { content:":"; padding-left: 0.3em; } -.optional { text-decoration: underline dotted; } - -/** Fancy colour display. */ -.colour-ref { - display: inline-block; - width: 0.8em; - height: 0.8em; - margin: 0.1em 0.1em 0.3em 0.1em; /* Terrrible hack to force vertical alignment. */ - border: solid 1px black; - box-sizing: border-box; - vertical-align: middle; -} - -/** Fancy keyboard shortcut styling, inspired by GitHub markdown. */ -kbd { - display: inline-block; - padding: 4px 5px; - font-size: 0.8em; - line-height: 10px; - color: #444d56; - vertical-align: middle; - background-color: #fafbfc; - border: 1px solid #d1d5da; - border-radius: 3px; - box-shadow: inset 0 -1px 0 #d1d5da; -} - -/* styles for prettification of source */ -.highlight .comment { color: #558817; } -.highlight .constant { color: #a8660d; } -.highlight .escape { color: #844631; } -.highlight .keyword { color: #aa5050; font-weight: bold; } -.highlight .library { color: #0e7c6b; } -.highlight .marker { color: #512b1e; background: #fedc56; font-weight: bold; } -.highlight .string { color: #8080ff; } -.highlight .literal-kw { color: #8080ff; } -.highlight .number { color: #f8660d; } -.highlight .operator { color: #2239a8; font-weight: bold; } -.highlight .preprocessor, pre .prepro { color: #a33243; } -.highlight .global { color: #800080; } -.highlight .user-keyword { color: #800080; } -.highlight .prompt { color: #558817; } -.highlight .url { color: #272fc2; text-decoration: underline; } diff --git a/illuaminate.sexp b/illuaminate.sexp index b06417843..558028975 100644 --- a/illuaminate.sexp +++ b/illuaminate.sexp @@ -10,7 +10,10 @@ (doc (title "CC: Tweaked") + (destination doc/out) + (logo src/main/resources/pack.png) (index doc/index.md) + (styles doc/styles.css) (source-link https://github.com/SquidDev-CC/CC-Tweaked/blob/${commit}/${path}#L${line}) (module-kinds