diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index d21024f373..1f7a79a3d0 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -1,69 +1,80 @@ -# Workflow for building and deploying Etterna documentation -name: Etterna documentation CI +name: Docs CI on: - # Runs on pushes to develop push: branches: ["develop"] # Allows you to run this workflow manually from the Actions tab workflow_dispatch: -# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages -permissions: - contents: read - pages: write - id-token: write - # Allow one concurrent deployment concurrency: group: "pages" cancel-in-progress: true jobs: - #Build job - build: + gen-documentation: + name: Generate Documentation runs-on: ubuntu-latest + steps: - # Setup - - name: Checkout + - name: Checkout Etterna uses: actions/checkout@v3 - - name: Update apt - run: "sudo apt-get update" - - name: Install Ldoc - run: "bash ./.ci/install_ldoc.sh" - - name: Generate LDoc/Doxygen configs - run: "bash ./.ci/generate_doc_configs.sh" - #Jekyll build - - name: Setup Pages - uses: actions/configure-pages@v2 - - name: Build with Jekyll - uses: actions/jekyll-build-pages@v1 with: - source: ./Docs/ - destination: ./_site - #Ldoc build - - name: Run LDoc + path: main + + - name: Install apt packages + run: sudo apt-get update && sudo apt-get install -y build-essential cmake ninja-build + + - name: Install luver # Lua Version Manager + uses: MunifTanjim/luver-action@v1 + + - name: Install Lua and LuaRocks run: | - cd build - make ldoc - sudo mv ldoc_output ../_site/ldoc - #Doxygen build - - name: Run Doxygen + luver install lua 5.4.3 + luver use 5.4.3 + luver install luarocks 3.8.0 + + - name: Download doxygen binary and add to path run: | - cd build - make doxygen - sudo mv doxygen ../_site - - name: Upload artifact + curl -RO https://www.doxygen.nl/files/doxygen-1.9.6.linux.bin.tar.gz + tar -zxf doxygen-1.9.6.linux.bin.tar.gz + echo "$PWD/doxygen-1.9.6/bin" >> $GITHUB_PATH + + - name: Install Python3 + uses: actions/setup-python@v4 + with: + python-version: '3.10' + + - name: Install mkdocs + run: pip3 install mkdocs mkdocs-material + + - name: Install LDoc + run: luarocks install ldoc + + - name: Generate CMake + run: mkdir main/build && cd main/build && cmake -G Ninja -DDOCS_ONLY=1 .. + + - name: Build documentation website + run: cmake --build main/build --target build-docs-website + + - name: Upload docs_site to artifacts uses: actions/upload-pages-artifact@v1 + with: + name: github-pages + path: main/build/docs_site - # Deployment job deploy: + name: Upload to Github Pages + runs-on: ubuntu-latest + needs: gen-documentation + permissions: + pages: write + id-token: write environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} - runs-on: ubuntu-latest - needs: build + steps: - name: Deploy to GitHub Pages id: deployment diff --git a/CMake/Helpers/DocumentationTools.cmake b/CMake/Helpers/DocumentationTools.cmake index 932b2c74fd..aedd8eb913 100644 --- a/CMake/Helpers/DocumentationTools.cmake +++ b/CMake/Helpers/DocumentationTools.cmake @@ -1,9 +1,21 @@ +include(FetchContent) + +set(DOCS_OUTPUT_DIR ${PROJECT_BINARY_DIR}/docs_site) # doxygen find_package(Doxygen OPTIONAL_COMPONENTS dot) if(NOT DOXYGEN_FOUND) - message(STATUS "Doxygen not found. Documentation target will not be created.") + message(STATUS "Doxygen not found. Doxygen target will not be created. Please ensure doxygen is accessibe within your path.") else() + # Download Doxygen Theme + FetchContent_Declare(doxygen_theme + GIT_REPOSITORY https://github.com/jothepro/doxygen-awesome-css.git + GIT_TAG main + GIT_PROGRESS TRUE + GIT_SHALLOW TRUE) + FetchContent_MakeAvailable(doxygen_theme) + FetchContent_GetProperties(doxygen_theme SOURCE_DIR DOXY_THEME_DIR) + # set input and output files set(DOXYGEN_IN ${PROJECT_SOURCE_DIR}/Docs/Doxyfile.in) set(DOXYGEN_OUT ${PROJECT_BINARY_DIR}/Doxyfile) @@ -22,7 +34,7 @@ endif() # LDoc find_program(LDOC_EXE NAMES "ldoc" "ldoc.bat") if(NOT LDOC_EXE) - message(STATUS "LDoc not found. Documentation target will not be created.") + message(STATUS "LDoc not found. LDoc target will not be created. Please ensure ldoc is accessible within your path.") else() # set input and output files set(LDOC_IN ${PROJECT_SOURCE_DIR}/Docs/LDoc.in) @@ -38,4 +50,31 @@ else() WORKING_DIRECTORY ${PROJECT_BINARY_DIR} COMMAND ${LDOC_EXE} .) +endif() + +# mkdocs +find_program(MKDOCS_EXE NAMES "mkdocs") +if(NOT MKDOCS_EXE) + message(STATUS "mkdocs not found. Please ensure mkdocs is accessible within your path.") +else() + # set input and output files + set(MKDOCS_IN ${PROJECT_SOURCE_DIR}/Docs/mkdocs.yml.in) + set(MKDOCS_OUT ${PROJECT_BINARY_DIR}/mkdocs.yml) + + # configure the file + configure_file(${MKDOCS_IN} ${MKDOCS_OUT} @ONLY) + + add_custom_target(mkdocs + COMMENT "Generating mkdocs website" + VERBATIM + WORKING_DIRECTORY ${PROJECT_BINARY_DIR} + COMMAND ${MKDOCS_EXE} build --site-dir ${DOCS_OUTPUT_DIR} + ) + + add_custom_target(build-docs-website + WORKING_DIRECTORY ${PROJECT_BINARY_DIR} + COMMAND cmake --build ${PROJECT_BINARY_DIR} --target mkdocs + COMMAND cmake --build ${PROJECT_BINARY_DIR} --target doxygen + COMMAND cmake --build ${PROJECT_BINARY_DIR} --target ldoc + ) endif() \ No newline at end of file diff --git a/CMakeLists.txt b/CMakeLists.txt index 09b8180cac..e1ea655939 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -32,11 +32,20 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS ON) # Export compile set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/CMake/Modules) # Tell CMake where to access FindXXX.cmake files set_property(GLOBAL PROPERTY USE_FOLDERS ON) # Enable folders/filters within IDEs -# Project Build Targets -add_executable(Etterna) - # Project Compile Options set(WITH_CRASHPAD TRUE CACHE BOOL "Compile with Crash Handler (Requires depot_tools installed)") +set(DOCS_ONLY FALSE CACHE BOOL "Only prepare CMake for documentation. Do not prepare for game compilation.") + +## Documentation Preparation +include(CMake/Helpers/DocumentationTools.cmake) + +## Do not continue processing if user only wants to build documentation. +if(DOCS_ONLY) + return() +endif() + +# Project Build Targets +add_executable(Etterna) ## Setting Target Properties ### Set a different name for each output binary depending on what build configuration is. @@ -141,9 +150,6 @@ endif() # Static Analysis include(CMake/Helpers/StaticAnalysis.cmake) -# Documentation -include(CMake/Helpers/DocumentationTools.cmake) - # CPack Initialization include(CMake/Helpers/CPackSetup.cmake) include(CPack) diff --git a/Docs/Doxyfile.in b/Docs/Doxyfile.in index f18f3cd5b6..9e82e418ce 100644 --- a/Docs/Doxyfile.in +++ b/Docs/Doxyfile.in @@ -5,13 +5,18 @@ DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = Etterna OUTPUT_LANGUAGE = English PROJECT_NUMBER = @PROJECT_VERSION@ -OUTPUT_DIRECTORY = @PROJECT_BINARY_DIR@/doxygen +OUTPUT_DIRECTORY = @DOCS_OUTPUT_DIR@/doxygen INPUT = @PROJECT_SOURCE_DIR@/src INPUT_ENCODING = UTF-8 RECURSIVE = YES +EXCLUDE_PATTERNS = */InputHandler/*.md # HTML GENERATE_HTML = YES +GENERATE_TREEVIEW = YES +HTML_TIMESTAMP = YES +HTML_DYNAMIC_MENUS = YES +HTML_DYNAMIC_SECTIONS = YES HTML_OUTPUT = html # DOT @@ -21,3 +26,17 @@ DOT_NUM_THREADS = 0 # LATEX GENERATE_LATEX = NO + +# THEME AWESOME DOXYGEN +WARN_IF_UNDOCUMENTED = NO +GENERATE_TREEVIEW = YES # required! +DISABLE_INDEX = NO +FULL_SIDEBAR = NO +HTML_COLORSTYLE = LIGHT +PROJECT_LOGO = @PROJECT_SOURCE_DIR@/Docs/docs/images/etterna-logo-light-transparent.svg +HTML_HEADER = @PROJECT_SOURCE_DIR@/Docs/style/doxygen/header.html +HTML_EXTRA_FILES = @DOXY_THEME_DIR@/doxygen-awesome-darkmode-toggle.js +HTML_EXTRA_STYLESHEET = @DOXY_THEME_DIR@/doxygen-awesome.css \ + @DOXY_THEME_DIR@/doxygen-awesome-sidebar-only.css \ + @DOXY_THEME_DIR@/doxygen-awesome-sidebar-only-darkmode-toggle.css \ + @PROJECT_SOURCE_DIR@/Docs/style/doxygen/style.css \ No newline at end of file diff --git a/Docs/LDoc.in b/Docs/LDoc.in index ee6f6766fd..7b8cfc316a 100644 --- a/Docs/LDoc.in +++ b/Docs/LDoc.in @@ -3,7 +3,7 @@ title = "Etterna Lua Documentation" description = "A cross-platform rhythm game" -- Output directory -dir = "@PROJECT_BINARY_DIR@/ldoc_output" +dir = "@DOCS_OUTPUT_DIR@/ldoc" -- Source files file = {"@PROJECT_SOURCE_DIR@/Themes/_fallback/Scripts/", "@PROJECT_SOURCE_DIR@/Themes/_fallback/docs/"} diff --git a/Docs/_config.yml b/Docs/_config.yml deleted file mode 100644 index a96fd5973e..0000000000 --- a/Docs/_config.yml +++ /dev/null @@ -1,12 +0,0 @@ -#Jekyll config file for Etterna documentation CI -remote_theme: just-the-docs/just-the-docs -color_scheme: etterna -nav_external_links: - - title: Etterna C++ Documentation - url: doxygen/html/index.html - hide_icon: false - - title: Etterna Lua Documentation - url: ldoc/index.html - hide_icon: false - -include: Contributing.md # No clue why this is needed explicitly \ No newline at end of file diff --git a/Docs/_sass/color_schemes/etterna.scss b/Docs/_sass/color_schemes/etterna.scss deleted file mode 100644 index 245b1753ed..0000000000 --- a/Docs/_sass/color_schemes/etterna.scss +++ /dev/null @@ -1,5 +0,0 @@ -//See: https://github.com/just-the-docs/just-the-docs/blob/main/_sass/support/_variables.scss -// https://just-the-docs.github.io/just-the-docs/docs/customization/#define-a-custom-scheme - -$purple-000: #614080; -$link-color: $purple-000; // Cascade update down (this isn't automatic) \ No newline at end of file diff --git a/Docs/Bugreporting.md b/Docs/docs/Bugreporting.md similarity index 100% rename from Docs/Bugreporting.md rename to Docs/docs/Bugreporting.md diff --git a/Docs/Building.md b/Docs/docs/Building.md similarity index 100% rename from Docs/Building.md rename to Docs/docs/Building.md diff --git a/Docs/Contributing.md b/Docs/docs/Contributing.md similarity index 100% rename from Docs/Contributing.md rename to Docs/docs/Contributing.md diff --git a/Docs/Crashpad.md b/Docs/docs/Crashpad.md similarity index 100% rename from Docs/Crashpad.md rename to Docs/docs/Crashpad.md diff --git a/Docs/README.md b/Docs/docs/README.md similarity index 100% rename from Docs/README.md rename to Docs/docs/README.md diff --git a/Docs/Translations.md b/Docs/docs/Translations.md similarity index 100% rename from Docs/Translations.md rename to Docs/docs/Translations.md diff --git a/Docs/documentation/editing_site.md b/Docs/docs/editing_docs.md similarity index 100% rename from Docs/documentation/editing_site.md rename to Docs/docs/editing_docs.md diff --git a/Docs/images/cmake-gui-01.png b/Docs/docs/images/cmake-gui-01.png similarity index 100% rename from Docs/images/cmake-gui-01.png rename to Docs/docs/images/cmake-gui-01.png diff --git a/Docs/images/cmake-gui-02.png b/Docs/docs/images/cmake-gui-02.png similarity index 100% rename from Docs/images/cmake-gui-02.png rename to Docs/docs/images/cmake-gui-02.png diff --git a/Docs/images/cmake-gui-03.png b/Docs/docs/images/cmake-gui-03.png similarity index 100% rename from Docs/images/cmake-gui-03.png rename to Docs/docs/images/cmake-gui-03.png diff --git a/Docs/images/etterna-logo-dark.svg b/Docs/docs/images/etterna-logo-dark.svg similarity index 100% rename from Docs/images/etterna-logo-dark.svg rename to Docs/docs/images/etterna-logo-dark.svg diff --git a/Docs/docs/images/etterna-logo-light-transparent.svg b/Docs/docs/images/etterna-logo-light-transparent.svg new file mode 100644 index 0000000000..2f0dac56f9 --- /dev/null +++ b/Docs/docs/images/etterna-logo-light-transparent.svg @@ -0,0 +1,8 @@ + + + Layer 1 + + + + + \ No newline at end of file diff --git a/Docs/images/etterna-logo-light.svg b/Docs/docs/images/etterna-logo-light.svg similarity index 100% rename from Docs/images/etterna-logo-light.svg rename to Docs/docs/images/etterna-logo-light.svg diff --git a/Docs/images/etterna-welcome.png b/Docs/docs/images/etterna-welcome.png similarity index 100% rename from Docs/images/etterna-welcome.png rename to Docs/docs/images/etterna-welcome.png diff --git a/Docs/legacy/Changelog_SSCformat.txt b/Docs/docs/legacy/Changelog_SSCformat.txt similarity index 100% rename from Docs/legacy/Changelog_SSCformat.txt rename to Docs/docs/legacy/Changelog_SSCformat.txt diff --git a/Docs/legacy/Changelog_language.txt b/Docs/docs/legacy/Changelog_language.txt similarity index 100% rename from Docs/legacy/Changelog_language.txt rename to Docs/docs/legacy/Changelog_language.txt diff --git a/Docs/legacy/Changelog_sm-ssc.txt b/Docs/docs/legacy/Changelog_sm-ssc.txt similarity index 100% rename from Docs/legacy/Changelog_sm-ssc.txt rename to Docs/docs/legacy/Changelog_sm-ssc.txt diff --git a/Docs/legacy/Changelog_sm5.txt b/Docs/docs/legacy/Changelog_sm5.txt similarity index 100% rename from Docs/legacy/Changelog_sm5.txt rename to Docs/docs/legacy/Changelog_sm5.txt diff --git a/Docs/legacy/CommandLineArgs.txt b/Docs/docs/legacy/CommandLineArgs.txt similarity index 100% rename from Docs/legacy/CommandLineArgs.txt rename to Docs/docs/legacy/CommandLineArgs.txt diff --git a/Docs/legacy/Copying.MAD b/Docs/docs/legacy/Copying.MAD similarity index 100% rename from Docs/legacy/Copying.MAD rename to Docs/docs/legacy/Copying.MAD diff --git a/Docs/legacy/CourseFormat.txt b/Docs/docs/legacy/CourseFormat.txt similarity index 100% rename from Docs/legacy/CourseFormat.txt rename to Docs/docs/legacy/CourseFormat.txt diff --git a/Docs/legacy/CustomMissionReference.txt b/Docs/docs/legacy/CustomMissionReference.txt similarity index 100% rename from Docs/legacy/CustomMissionReference.txt rename to Docs/docs/legacy/CustomMissionReference.txt diff --git a/Docs/legacy/Devdocs/BuildingFfmpegOnMac.txt b/Docs/docs/legacy/Devdocs/BuildingFfmpegOnMac.txt similarity index 100% rename from Docs/legacy/Devdocs/BuildingFfmpegOnMac.txt rename to Docs/docs/legacy/Devdocs/BuildingFfmpegOnMac.txt diff --git a/Docs/legacy/Devdocs/CodingStyle.txt b/Docs/docs/legacy/Devdocs/CodingStyle.txt similarity index 100% rename from Docs/legacy/Devdocs/CodingStyle.txt rename to Docs/docs/legacy/Devdocs/CodingStyle.txt diff --git a/Docs/legacy/Devdocs/CompileFlags.txt b/Docs/docs/legacy/Devdocs/CompileFlags.txt similarity index 100% rename from Docs/legacy/Devdocs/CompileFlags.txt rename to Docs/docs/legacy/Devdocs/CompileFlags.txt diff --git a/Docs/legacy/Devdocs/GoldenRules.txt b/Docs/docs/legacy/Devdocs/GoldenRules.txt similarity index 100% rename from Docs/legacy/Devdocs/GoldenRules.txt rename to Docs/docs/legacy/Devdocs/GoldenRules.txt diff --git a/Docs/legacy/Devdocs/NegBPMsTutorial.html b/Docs/docs/legacy/Devdocs/NegBPMsTutorial.html similarity index 100% rename from Docs/legacy/Devdocs/NegBPMsTutorial.html rename to Docs/docs/legacy/Devdocs/NegBPMsTutorial.html diff --git a/Docs/legacy/Devdocs/SMLanProtocol.txt b/Docs/docs/legacy/Devdocs/SMLanProtocol.txt similarity index 100% rename from Docs/legacy/Devdocs/SMLanProtocol.txt rename to Docs/docs/legacy/Devdocs/SMLanProtocol.txt diff --git a/Docs/legacy/Devdocs/SMO_protocol-aj.txt b/Docs/docs/legacy/Devdocs/SMO_protocol-aj.txt similarity index 100% rename from Docs/legacy/Devdocs/SMO_protocol-aj.txt rename to Docs/docs/legacy/Devdocs/SMO_protocol-aj.txt diff --git a/Docs/legacy/Devdocs/SMXML.txt b/Docs/docs/legacy/Devdocs/SMXML.txt similarity index 100% rename from Docs/legacy/Devdocs/SMXML.txt rename to Docs/docs/legacy/Devdocs/SMXML.txt diff --git a/Docs/legacy/Devdocs/Sound Drivers.txt b/Docs/docs/legacy/Devdocs/Sound Drivers.txt similarity index 100% rename from Docs/legacy/Devdocs/Sound Drivers.txt rename to Docs/docs/legacy/Devdocs/Sound Drivers.txt diff --git a/Docs/legacy/Devdocs/SplitTiming.txt b/Docs/docs/legacy/Devdocs/SplitTiming.txt similarity index 100% rename from Docs/legacy/Devdocs/SplitTiming.txt rename to Docs/docs/legacy/Devdocs/SplitTiming.txt diff --git a/Docs/legacy/Devdocs/TextEntry.txt b/Docs/docs/legacy/Devdocs/TextEntry.txt similarity index 100% rename from Docs/legacy/Devdocs/TextEntry.txt rename to Docs/docs/legacy/Devdocs/TextEntry.txt diff --git a/Docs/legacy/Devdocs/WarpNotes.txt b/Docs/docs/legacy/Devdocs/WarpNotes.txt similarity index 100% rename from Docs/legacy/Devdocs/WarpNotes.txt rename to Docs/docs/legacy/Devdocs/WarpNotes.txt diff --git a/Docs/legacy/Devdocs/ezsockets.txt b/Docs/docs/legacy/Devdocs/ezsockets.txt similarity index 100% rename from Docs/legacy/Devdocs/ezsockets.txt rename to Docs/docs/legacy/Devdocs/ezsockets.txt diff --git a/Docs/legacy/Devdocs/interesting_sm4_commit_logs.txt b/Docs/docs/legacy/Devdocs/interesting_sm4_commit_logs.txt similarity index 100% rename from Docs/legacy/Devdocs/interesting_sm4_commit_logs.txt rename to Docs/docs/legacy/Devdocs/interesting_sm4_commit_logs.txt diff --git a/Docs/legacy/Devdocs/negbpmtut/screen00214.jpg b/Docs/docs/legacy/Devdocs/negbpmtut/screen00214.jpg similarity index 100% rename from Docs/legacy/Devdocs/negbpmtut/screen00214.jpg rename to Docs/docs/legacy/Devdocs/negbpmtut/screen00214.jpg diff --git a/Docs/legacy/Devdocs/negbpmtut/screen00215.jpg b/Docs/docs/legacy/Devdocs/negbpmtut/screen00215.jpg similarity index 100% rename from Docs/legacy/Devdocs/negbpmtut/screen00215.jpg rename to Docs/docs/legacy/Devdocs/negbpmtut/screen00215.jpg diff --git a/Docs/legacy/Devdocs/negbpmtut/screen00216.jpg b/Docs/docs/legacy/Devdocs/negbpmtut/screen00216.jpg similarity index 100% rename from Docs/legacy/Devdocs/negbpmtut/screen00216.jpg rename to Docs/docs/legacy/Devdocs/negbpmtut/screen00216.jpg diff --git a/Docs/legacy/Devdocs/negbpmtut/screen00217.jpg b/Docs/docs/legacy/Devdocs/negbpmtut/screen00217.jpg similarity index 100% rename from Docs/legacy/Devdocs/negbpmtut/screen00217.jpg rename to Docs/docs/legacy/Devdocs/negbpmtut/screen00217.jpg diff --git a/Docs/legacy/Devdocs/negbpmtut/screen00218.jpg b/Docs/docs/legacy/Devdocs/negbpmtut/screen00218.jpg similarity index 100% rename from Docs/legacy/Devdocs/negbpmtut/screen00218.jpg rename to Docs/docs/legacy/Devdocs/negbpmtut/screen00218.jpg diff --git a/Docs/legacy/Devdocs/negbpmtut/screen00221.jpg b/Docs/docs/legacy/Devdocs/negbpmtut/screen00221.jpg similarity index 100% rename from Docs/legacy/Devdocs/negbpmtut/screen00221.jpg rename to Docs/docs/legacy/Devdocs/negbpmtut/screen00221.jpg diff --git a/Docs/legacy/Devdocs/possible memory leaks.txt b/Docs/docs/legacy/Devdocs/possible memory leaks.txt similarity index 100% rename from Docs/legacy/Devdocs/possible memory leaks.txt rename to Docs/docs/legacy/Devdocs/possible memory leaks.txt diff --git a/Docs/legacy/Devdocs/rivaldata.txt b/Docs/docs/legacy/Devdocs/rivaldata.txt similarity index 100% rename from Docs/legacy/Devdocs/rivaldata.txt rename to Docs/docs/legacy/Devdocs/rivaldata.txt diff --git a/Docs/legacy/Devdocs/versioning.txt b/Docs/docs/legacy/Devdocs/versioning.txt similarity index 100% rename from Docs/legacy/Devdocs/versioning.txt rename to Docs/docs/legacy/Devdocs/versioning.txt diff --git a/Docs/legacy/KnownIssues.txt b/Docs/docs/legacy/KnownIssues.txt similarity index 100% rename from Docs/legacy/KnownIssues.txt rename to Docs/docs/legacy/KnownIssues.txt diff --git a/Docs/legacy/Licenses.txt b/Docs/docs/legacy/Licenses.txt similarity index 100% rename from Docs/legacy/Licenses.txt rename to Docs/docs/legacy/Licenses.txt diff --git a/Docs/legacy/Luadoc/Lua.xml b/Docs/docs/legacy/Luadoc/Lua.xml similarity index 100% rename from Docs/legacy/Luadoc/Lua.xml rename to Docs/docs/legacy/Luadoc/Lua.xml diff --git a/Docs/legacy/Luadoc/Lua.xsd b/Docs/docs/legacy/Luadoc/Lua.xsd similarity index 100% rename from Docs/legacy/Luadoc/Lua.xsd rename to Docs/docs/legacy/Luadoc/Lua.xsd diff --git a/Docs/legacy/Luadoc/Lua.xsl b/Docs/docs/legacy/Luadoc/Lua.xsl similarity index 100% rename from Docs/legacy/Luadoc/Lua.xsl rename to Docs/docs/legacy/Luadoc/Lua.xsl diff --git a/Docs/legacy/Luadoc/LuaDocumentation.xml b/Docs/docs/legacy/Luadoc/LuaDocumentation.xml similarity index 100% rename from Docs/legacy/Luadoc/LuaDocumentation.xml rename to Docs/docs/legacy/Luadoc/LuaDocumentation.xml diff --git a/Docs/legacy/Luadoc/a.lua b/Docs/docs/legacy/Luadoc/a.lua similarity index 100% rename from Docs/legacy/Luadoc/a.lua rename to Docs/docs/legacy/Luadoc/a.lua diff --git a/Docs/legacy/Luadoc/bgline.png b/Docs/docs/legacy/Luadoc/bgline.png similarity index 100% rename from Docs/legacy/Luadoc/bgline.png rename to Docs/docs/legacy/Luadoc/bgline.png diff --git a/Docs/legacy/Luadoc/closed.gif b/Docs/docs/legacy/Luadoc/closed.gif similarity index 100% rename from Docs/legacy/Luadoc/closed.gif rename to Docs/docs/legacy/Luadoc/closed.gif diff --git a/Docs/legacy/Luadoc/favicon.ico b/Docs/docs/legacy/Luadoc/favicon.ico similarity index 100% rename from Docs/legacy/Luadoc/favicon.ico rename to Docs/docs/legacy/Luadoc/favicon.ico diff --git a/Docs/legacy/Luadoc/open.gif b/Docs/docs/legacy/Luadoc/open.gif similarity index 100% rename from Docs/legacy/Luadoc/open.gif rename to Docs/docs/legacy/Luadoc/open.gif diff --git a/Docs/legacy/Mapping_keys_for_edit_mode.txt b/Docs/docs/legacy/Mapping_keys_for_edit_mode.txt similarity index 100% rename from Docs/legacy/Mapping_keys_for_edit_mode.txt rename to Docs/docs/legacy/Mapping_keys_for_edit_mode.txt diff --git a/Docs/legacy/README-GUIDELINES b/Docs/docs/legacy/README-GUIDELINES similarity index 100% rename from Docs/legacy/README-GUIDELINES rename to Docs/docs/legacy/README-GUIDELINES diff --git a/Docs/legacy/SimfileFormats/BMS/BM98Data_format_specification.html b/Docs/docs/legacy/SimfileFormats/BMS/BM98Data_format_specification.html similarity index 100% rename from Docs/legacy/SimfileFormats/BMS/BM98Data_format_specification.html rename to Docs/docs/legacy/SimfileFormats/BMS/BM98Data_format_specification.html diff --git a/Docs/legacy/SimfileFormats/BMS/BM98FinalSecret.html b/Docs/docs/legacy/SimfileFormats/BMS/BM98FinalSecret.html similarity index 100% rename from Docs/legacy/SimfileFormats/BMS/BM98FinalSecret.html rename to Docs/docs/legacy/SimfileFormats/BMS/BM98FinalSecret.html diff --git a/Docs/legacy/SimfileFormats/BMS/BMS_Reading_Tutorial.rtf b/Docs/docs/legacy/SimfileFormats/BMS/BMS_Reading_Tutorial.rtf similarity index 100% rename from Docs/legacy/SimfileFormats/BMS/BMS_Reading_Tutorial.rtf rename to Docs/docs/legacy/SimfileFormats/BMS/BMS_Reading_Tutorial.rtf diff --git a/Docs/legacy/SimfileFormats/BMS/BMS_Reading_Tutorial.txt b/Docs/docs/legacy/SimfileFormats/BMS/BMS_Reading_Tutorial.txt similarity index 100% rename from Docs/legacy/SimfileFormats/BMS/BMS_Reading_Tutorial.txt rename to Docs/docs/legacy/SimfileFormats/BMS/BMS_Reading_Tutorial.txt diff --git a/Docs/legacy/SimfileFormats/BMS/_src.txt b/Docs/docs/legacy/SimfileFormats/BMS/_src.txt similarity index 100% rename from Docs/legacy/SimfileFormats/BMS/_src.txt rename to Docs/docs/legacy/SimfileFormats/BMS/_src.txt diff --git a/Docs/legacy/SimfileFormats/BMS/tmp.txt b/Docs/docs/legacy/SimfileFormats/BMS/tmp.txt similarity index 100% rename from Docs/legacy/SimfileFormats/BMS/tmp.txt rename to Docs/docs/legacy/SimfileFormats/BMS/tmp.txt diff --git a/Docs/legacy/SimfileFormats/DWI/DWI.txt b/Docs/docs/legacy/SimfileFormats/DWI/DWI.txt similarity index 100% rename from Docs/legacy/SimfileFormats/DWI/DWI.txt rename to Docs/docs/legacy/SimfileFormats/DWI/DWI.txt diff --git a/Docs/legacy/SimfileFormats/DWI/readme.html b/Docs/docs/legacy/SimfileFormats/DWI/readme.html similarity index 100% rename from Docs/legacy/SimfileFormats/DWI/readme.html rename to Docs/docs/legacy/SimfileFormats/DWI/readme.html diff --git a/Docs/legacy/SimfileFormats/KSF/_src.txt b/Docs/docs/legacy/SimfileFormats/KSF/_src.txt similarity index 100% rename from Docs/legacy/SimfileFormats/KSF/_src.txt rename to Docs/docs/legacy/SimfileFormats/KSF/_src.txt diff --git a/Docs/legacy/SimfileFormats/KSF/ksf-format.txt b/Docs/docs/legacy/SimfileFormats/KSF/ksf-format.txt similarity index 100% rename from Docs/legacy/SimfileFormats/KSF/ksf-format.txt rename to Docs/docs/legacy/SimfileFormats/KSF/ksf-format.txt diff --git a/Docs/legacy/SimfileFormats/KSF/sample.ksf b/Docs/docs/legacy/SimfileFormats/KSF/sample.ksf similarity index 100% rename from Docs/legacy/SimfileFormats/KSF/sample.ksf rename to Docs/docs/legacy/SimfileFormats/KSF/sample.ksf diff --git a/Docs/legacy/SimfileFormats/README b/Docs/docs/legacy/SimfileFormats/README similarity index 100% rename from Docs/legacy/SimfileFormats/README rename to Docs/docs/legacy/SimfileFormats/README diff --git a/Docs/legacy/SimfileFormats/SDF/SDF.txt b/Docs/docs/legacy/SimfileFormats/SDF/SDF.txt similarity index 100% rename from Docs/legacy/SimfileFormats/SDF/SDF.txt rename to Docs/docs/legacy/SimfileFormats/SDF/SDF.txt diff --git a/Docs/legacy/SimfileFormats/SDF/ssc-banner.png b/Docs/docs/legacy/SimfileFormats/SDF/ssc-banner.png similarity index 100% rename from Docs/legacy/SimfileFormats/SDF/ssc-banner.png rename to Docs/docs/legacy/SimfileFormats/SDF/ssc-banner.png diff --git a/Docs/legacy/SimfileFormats/SDF/ssc-bg.png b/Docs/docs/legacy/SimfileFormats/SDF/ssc-bg.png similarity index 100% rename from Docs/legacy/SimfileFormats/SDF/ssc-bg.png rename to Docs/docs/legacy/SimfileFormats/SDF/ssc-bg.png diff --git a/Docs/legacy/SimfileFormats/SDF/test-1bpm.sdf b/Docs/docs/legacy/SimfileFormats/SDF/test-1bpm.sdf similarity index 100% rename from Docs/legacy/SimfileFormats/SDF/test-1bpm.sdf rename to Docs/docs/legacy/SimfileFormats/SDF/test-1bpm.sdf diff --git a/Docs/legacy/SimfileFormats/SDF/test.sdf b/Docs/docs/legacy/SimfileFormats/SDF/test.sdf similarity index 100% rename from Docs/legacy/SimfileFormats/SDF/test.sdf rename to Docs/docs/legacy/SimfileFormats/SDF/test.sdf diff --git a/Docs/legacy/SimfileFormats/SDF/test.sm b/Docs/docs/legacy/SimfileFormats/SDF/test.sm similarity index 100% rename from Docs/legacy/SimfileFormats/SDF/test.sm rename to Docs/docs/legacy/SimfileFormats/SDF/test.sm diff --git a/Docs/legacy/SimfileFormats/dance-spec.txt b/Docs/docs/legacy/SimfileFormats/dance-spec.txt similarity index 100% rename from Docs/legacy/SimfileFormats/dance-spec.txt rename to Docs/docs/legacy/SimfileFormats/dance-spec.txt diff --git a/Docs/legacy/SimfileFormats/misc.txt b/Docs/docs/legacy/SimfileFormats/misc.txt similarity index 100% rename from Docs/legacy/SimfileFormats/misc.txt rename to Docs/docs/legacy/SimfileFormats/misc.txt diff --git a/Docs/legacy/SimfileFormats/new format draft.txt b/Docs/docs/legacy/SimfileFormats/new format draft.txt similarity index 100% rename from Docs/legacy/SimfileFormats/new format draft.txt rename to Docs/docs/legacy/SimfileFormats/new format draft.txt diff --git a/Docs/legacy/SimfileFormats/ssc_msd5.txt b/Docs/docs/legacy/SimfileFormats/ssc_msd5.txt similarity index 100% rename from Docs/legacy/SimfileFormats/ssc_msd5.txt rename to Docs/docs/legacy/SimfileFormats/ssc_msd5.txt diff --git a/Docs/legacy/Stats.xml b/Docs/docs/legacy/Stats.xml similarity index 100% rename from Docs/legacy/Stats.xml rename to Docs/docs/legacy/Stats.xml diff --git a/Docs/legacy/Themerdocs/Examples/Example_Actors/ActorFrame.lua b/Docs/docs/legacy/Themerdocs/Examples/Example_Actors/ActorFrame.lua similarity index 100% rename from Docs/legacy/Themerdocs/Examples/Example_Actors/ActorFrame.lua rename to Docs/docs/legacy/Themerdocs/Examples/Example_Actors/ActorFrame.lua diff --git a/Docs/legacy/Themerdocs/Examples/Example_Actors/ActorFrameTexture.lua b/Docs/docs/legacy/Themerdocs/Examples/Example_Actors/ActorFrameTexture.lua similarity index 100% rename from Docs/legacy/Themerdocs/Examples/Example_Actors/ActorFrameTexture.lua rename to Docs/docs/legacy/Themerdocs/Examples/Example_Actors/ActorFrameTexture.lua diff --git a/Docs/legacy/Themerdocs/Examples/Example_Actors/ActorScroller.lua b/Docs/docs/legacy/Themerdocs/Examples/Example_Actors/ActorScroller.lua similarity index 100% rename from Docs/legacy/Themerdocs/Examples/Example_Actors/ActorScroller.lua rename to Docs/docs/legacy/Themerdocs/Examples/Example_Actors/ActorScroller.lua diff --git a/Docs/legacy/Themerdocs/Examples/Example_Actors/BitmapText.lua b/Docs/docs/legacy/Themerdocs/Examples/Example_Actors/BitmapText.lua similarity index 100% rename from Docs/legacy/Themerdocs/Examples/Example_Actors/BitmapText.lua rename to Docs/docs/legacy/Themerdocs/Examples/Example_Actors/BitmapText.lua diff --git a/Docs/legacy/Themerdocs/Examples/Example_Actors/Quad.lua b/Docs/docs/legacy/Themerdocs/Examples/Example_Actors/Quad.lua similarity index 100% rename from Docs/legacy/Themerdocs/Examples/Example_Actors/Quad.lua rename to Docs/docs/legacy/Themerdocs/Examples/Example_Actors/Quad.lua diff --git a/Docs/legacy/Themerdocs/Examples/Example_Actors/RollingNumbers.lua b/Docs/docs/legacy/Themerdocs/Examples/Example_Actors/RollingNumbers.lua similarity index 100% rename from Docs/legacy/Themerdocs/Examples/Example_Actors/RollingNumbers.lua rename to Docs/docs/legacy/Themerdocs/Examples/Example_Actors/RollingNumbers.lua diff --git a/Docs/legacy/Themerdocs/Examples/Example_Actors/Toasty.lua b/Docs/docs/legacy/Themerdocs/Examples/Example_Actors/Toasty.lua similarity index 100% rename from Docs/legacy/Themerdocs/Examples/Example_Actors/Toasty.lua rename to Docs/docs/legacy/Themerdocs/Examples/Example_Actors/Toasty.lua diff --git a/Docs/legacy/Themerdocs/Examples/Example_Screens/ScreenHeartEntry.lua b/Docs/docs/legacy/Themerdocs/Examples/Example_Screens/ScreenHeartEntry.lua similarity index 100% rename from Docs/legacy/Themerdocs/Examples/Example_Screens/ScreenHeartEntry.lua rename to Docs/docs/legacy/Themerdocs/Examples/Example_Screens/ScreenHeartEntry.lua diff --git a/Docs/legacy/Themerdocs/Examples/Example_Screens/ScreenMapControllers.lua b/Docs/docs/legacy/Themerdocs/Examples/Example_Screens/ScreenMapControllers.lua similarity index 100% rename from Docs/legacy/Themerdocs/Examples/Example_Screens/ScreenMapControllers.lua rename to Docs/docs/legacy/Themerdocs/Examples/Example_Screens/ScreenMapControllers.lua diff --git a/Docs/legacy/Themerdocs/Examples/Example_Screens/ScreenOptionsExample.ini b/Docs/docs/legacy/Themerdocs/Examples/Example_Screens/ScreenOptionsExample.ini similarity index 100% rename from Docs/legacy/Themerdocs/Examples/Example_Screens/ScreenOptionsExample.ini rename to Docs/docs/legacy/Themerdocs/Examples/Example_Screens/ScreenOptionsExample.ini diff --git a/Docs/legacy/Themerdocs/Examples/Example_Themes/One_Screen_Example_Theme/BGAnimations/ScreenSimpleExample overlay.lua b/Docs/docs/legacy/Themerdocs/Examples/Example_Themes/One_Screen_Example_Theme/BGAnimations/ScreenSimpleExample overlay.lua similarity index 100% rename from Docs/legacy/Themerdocs/Examples/Example_Themes/One_Screen_Example_Theme/BGAnimations/ScreenSimpleExample overlay.lua rename to Docs/docs/legacy/Themerdocs/Examples/Example_Themes/One_Screen_Example_Theme/BGAnimations/ScreenSimpleExample overlay.lua diff --git a/Docs/legacy/Themerdocs/Examples/Example_Themes/One_Screen_Example_Theme/ThemeInfo.ini b/Docs/docs/legacy/Themerdocs/Examples/Example_Themes/One_Screen_Example_Theme/ThemeInfo.ini similarity index 100% rename from Docs/legacy/Themerdocs/Examples/Example_Themes/One_Screen_Example_Theme/ThemeInfo.ini rename to Docs/docs/legacy/Themerdocs/Examples/Example_Themes/One_Screen_Example_Theme/ThemeInfo.ini diff --git a/Docs/legacy/Themerdocs/Examples/Example_Themes/One_Screen_Example_Theme/metrics.ini b/Docs/docs/legacy/Themerdocs/Examples/Example_Themes/One_Screen_Example_Theme/metrics.ini similarity index 100% rename from Docs/legacy/Themerdocs/Examples/Example_Themes/One_Screen_Example_Theme/metrics.ini rename to Docs/docs/legacy/Themerdocs/Examples/Example_Themes/One_Screen_Example_Theme/metrics.ini diff --git a/Docs/legacy/Themerdocs/Examples/Example_Themes/One_Screen_Example_Theme/readme.txt b/Docs/docs/legacy/Themerdocs/Examples/Example_Themes/One_Screen_Example_Theme/readme.txt similarity index 100% rename from Docs/legacy/Themerdocs/Examples/Example_Themes/One_Screen_Example_Theme/readme.txt rename to Docs/docs/legacy/Themerdocs/Examples/Example_Themes/One_Screen_Example_Theme/readme.txt diff --git a/Docs/legacy/Themerdocs/Examples/OptionRowHandlerLua.lua b/Docs/docs/legacy/Themerdocs/Examples/OptionRowHandlerLua.lua similarity index 100% rename from Docs/legacy/Themerdocs/Examples/OptionRowHandlerLua.lua rename to Docs/docs/legacy/Themerdocs/Examples/OptionRowHandlerLua.lua diff --git a/Docs/legacy/Themerdocs/Examples/anatomy_of_an_actor.lua b/Docs/docs/legacy/Themerdocs/Examples/anatomy_of_an_actor.lua similarity index 100% rename from Docs/legacy/Themerdocs/Examples/anatomy_of_an_actor.lua rename to Docs/docs/legacy/Themerdocs/Examples/anatomy_of_an_actor.lua diff --git a/Docs/legacy/Themerdocs/Noteskin elements Reference.txt b/Docs/docs/legacy/Themerdocs/Noteskin elements Reference.txt similarity index 100% rename from Docs/legacy/Themerdocs/Noteskin elements Reference.txt rename to Docs/docs/legacy/Themerdocs/Noteskin elements Reference.txt diff --git a/Docs/legacy/Themerdocs/ScreenAMVTest overlay.lua b/Docs/docs/legacy/Themerdocs/ScreenAMVTest overlay.lua similarity index 100% rename from Docs/legacy/Themerdocs/ScreenAMVTest overlay.lua rename to Docs/docs/legacy/Themerdocs/ScreenAMVTest overlay.lua diff --git a/Docs/legacy/Themerdocs/ScreenMessages.txt b/Docs/docs/legacy/Themerdocs/ScreenMessages.txt similarity index 100% rename from Docs/legacy/Themerdocs/ScreenMessages.txt rename to Docs/docs/legacy/Themerdocs/ScreenMessages.txt diff --git a/Docs/legacy/Themerdocs/ScreenTextEntry.txt b/Docs/docs/legacy/Themerdocs/ScreenTextEntry.txt similarity index 100% rename from Docs/legacy/Themerdocs/ScreenTextEntry.txt rename to Docs/docs/legacy/Themerdocs/ScreenTextEntry.txt diff --git a/Docs/legacy/Themerdocs/ThemePrefs.txt b/Docs/docs/legacy/Themerdocs/ThemePrefs.txt similarity index 100% rename from Docs/legacy/Themerdocs/ThemePrefs.txt rename to Docs/docs/legacy/Themerdocs/ThemePrefs.txt diff --git a/Docs/legacy/Themerdocs/ThemePrefsRows.txt b/Docs/docs/legacy/Themerdocs/ThemePrefsRows.txt similarity index 100% rename from Docs/legacy/Themerdocs/ThemePrefsRows.txt rename to Docs/docs/legacy/Themerdocs/ThemePrefsRows.txt diff --git a/Docs/legacy/Themerdocs/XmlToLua.txt b/Docs/docs/legacy/Themerdocs/XmlToLua.txt similarity index 100% rename from Docs/legacy/Themerdocs/XmlToLua.txt rename to Docs/docs/legacy/Themerdocs/XmlToLua.txt diff --git a/Docs/legacy/Themerdocs/actordef.txt b/Docs/docs/legacy/Themerdocs/actordef.txt similarity index 100% rename from Docs/legacy/Themerdocs/actordef.txt rename to Docs/docs/legacy/Themerdocs/actordef.txt diff --git a/Docs/legacy/Themerdocs/announcer_files.txt b/Docs/docs/legacy/Themerdocs/announcer_files.txt similarity index 100% rename from Docs/legacy/Themerdocs/announcer_files.txt rename to Docs/docs/legacy/Themerdocs/announcer_files.txt diff --git a/Docs/legacy/Themerdocs/calories.txt b/Docs/docs/legacy/Themerdocs/calories.txt similarity index 100% rename from Docs/legacy/Themerdocs/calories.txt rename to Docs/docs/legacy/Themerdocs/calories.txt diff --git a/Docs/legacy/Themerdocs/conditional_music.txt b/Docs/docs/legacy/Themerdocs/conditional_music.txt similarity index 100% rename from Docs/legacy/Themerdocs/conditional_music.txt rename to Docs/docs/legacy/Themerdocs/conditional_music.txt diff --git a/Docs/legacy/Themerdocs/effect_colors.txt b/Docs/docs/legacy/Themerdocs/effect_colors.txt similarity index 100% rename from Docs/legacy/Themerdocs/effect_colors.txt rename to Docs/docs/legacy/Themerdocs/effect_colors.txt diff --git a/Docs/legacy/Themerdocs/fontini.txt b/Docs/docs/legacy/Themerdocs/fontini.txt similarity index 100% rename from Docs/legacy/Themerdocs/fontini.txt rename to Docs/docs/legacy/Themerdocs/fontini.txt diff --git a/Docs/legacy/Themerdocs/gamecommands.txt b/Docs/docs/legacy/Themerdocs/gamecommands.txt similarity index 100% rename from Docs/legacy/Themerdocs/gamecommands.txt rename to Docs/docs/legacy/Themerdocs/gamecommands.txt diff --git a/Docs/legacy/Themerdocs/haste.txt b/Docs/docs/legacy/Themerdocs/haste.txt similarity index 100% rename from Docs/legacy/Themerdocs/haste.txt rename to Docs/docs/legacy/Themerdocs/haste.txt diff --git a/Docs/legacy/Themerdocs/included_scripts.txt b/Docs/docs/legacy/Themerdocs/included_scripts.txt similarity index 100% rename from Docs/legacy/Themerdocs/included_scripts.txt rename to Docs/docs/legacy/Themerdocs/included_scripts.txt diff --git a/Docs/legacy/Themerdocs/modslevel.txt b/Docs/docs/legacy/Themerdocs/modslevel.txt similarity index 100% rename from Docs/legacy/Themerdocs/modslevel.txt rename to Docs/docs/legacy/Themerdocs/modslevel.txt diff --git a/Docs/legacy/Themerdocs/moremsg.txt b/Docs/docs/legacy/Themerdocs/moremsg.txt similarity index 100% rename from Docs/legacy/Themerdocs/moremsg.txt rename to Docs/docs/legacy/Themerdocs/moremsg.txt diff --git a/Docs/legacy/Themerdocs/pause_menu.md b/Docs/docs/legacy/Themerdocs/pause_menu.md similarity index 100% rename from Docs/legacy/Themerdocs/pause_menu.md rename to Docs/docs/legacy/Themerdocs/pause_menu.md diff --git a/Docs/legacy/Themerdocs/recommended_practices.txt b/Docs/docs/legacy/Themerdocs/recommended_practices.txt similarity index 100% rename from Docs/legacy/Themerdocs/recommended_practices.txt rename to Docs/docs/legacy/Themerdocs/recommended_practices.txt diff --git a/Docs/legacy/Themerdocs/sm-ssc_themeguide.txt b/Docs/docs/legacy/Themerdocs/sm-ssc_themeguide.txt similarity index 100% rename from Docs/legacy/Themerdocs/sm-ssc_themeguide.txt rename to Docs/docs/legacy/Themerdocs/sm-ssc_themeguide.txt diff --git a/Docs/legacy/Userdocs/Keymaps_ini_format.md b/Docs/docs/legacy/Userdocs/Keymaps_ini_format.md similarity index 100% rename from Docs/legacy/Userdocs/Keymaps_ini_format.md rename to Docs/docs/legacy/Userdocs/Keymaps_ini_format.md diff --git a/Docs/legacy/Userdocs/bgchanges_format.txt b/Docs/docs/legacy/Userdocs/bgchanges_format.txt similarity index 100% rename from Docs/legacy/Userdocs/bgchanges_format.txt rename to Docs/docs/legacy/Userdocs/bgchanges_format.txt diff --git a/Docs/legacy/Userdocs/sm5_beginner.txt b/Docs/docs/legacy/Userdocs/sm5_beginner.txt similarity index 100% rename from Docs/legacy/Userdocs/sm5_beginner.txt rename to Docs/docs/legacy/Userdocs/sm5_beginner.txt diff --git a/Docs/legacy/credits.txt b/Docs/docs/legacy/credits.txt similarity index 100% rename from Docs/legacy/credits.txt rename to Docs/docs/legacy/credits.txt diff --git a/Docs/legacy/docpack.zip b/Docs/docs/legacy/docpack.zip similarity index 100% rename from Docs/legacy/docpack.zip rename to Docs/docs/legacy/docpack.zip diff --git a/Docs/legacy/license-ext/Scoring-jp.txt b/Docs/docs/legacy/license-ext/Scoring-jp.txt similarity index 100% rename from Docs/legacy/license-ext/Scoring-jp.txt rename to Docs/docs/legacy/license-ext/Scoring-jp.txt diff --git a/Docs/legacy/license-ext/readme b/Docs/docs/legacy/license-ext/readme similarity index 100% rename from Docs/legacy/license-ext/readme rename to Docs/docs/legacy/license-ext/readme diff --git a/Docs/legacy/license-ext/theme_lang-ja.txt b/Docs/docs/legacy/license-ext/theme_lang-ja.txt similarity index 100% rename from Docs/legacy/license-ext/theme_lang-ja.txt rename to Docs/docs/legacy/license-ext/theme_lang-ja.txt diff --git a/Docs/legacy/license-ext/vlgothic/Changelog b/Docs/docs/legacy/license-ext/vlgothic/Changelog similarity index 100% rename from Docs/legacy/license-ext/vlgothic/Changelog rename to Docs/docs/legacy/license-ext/vlgothic/Changelog diff --git a/Docs/legacy/license-ext/vlgothic/LICENSE b/Docs/docs/legacy/license-ext/vlgothic/LICENSE similarity index 100% rename from Docs/legacy/license-ext/vlgothic/LICENSE rename to Docs/docs/legacy/license-ext/vlgothic/LICENSE diff --git a/Docs/legacy/license-ext/vlgothic/LICENSE.en b/Docs/docs/legacy/license-ext/vlgothic/LICENSE.en similarity index 100% rename from Docs/legacy/license-ext/vlgothic/LICENSE.en rename to Docs/docs/legacy/license-ext/vlgothic/LICENSE.en diff --git a/Docs/legacy/license-ext/vlgothic/LICENSE_E.mplus b/Docs/docs/legacy/license-ext/vlgothic/LICENSE_E.mplus similarity index 100% rename from Docs/legacy/license-ext/vlgothic/LICENSE_E.mplus rename to Docs/docs/legacy/license-ext/vlgothic/LICENSE_E.mplus diff --git a/Docs/legacy/license-ext/vlgothic/LICENSE_J.mplus b/Docs/docs/legacy/license-ext/vlgothic/LICENSE_J.mplus similarity index 100% rename from Docs/legacy/license-ext/vlgothic/LICENSE_J.mplus rename to Docs/docs/legacy/license-ext/vlgothic/LICENSE_J.mplus diff --git a/Docs/legacy/license-ext/vlgothic/README b/Docs/docs/legacy/license-ext/vlgothic/README similarity index 100% rename from Docs/legacy/license-ext/vlgothic/README rename to Docs/docs/legacy/license-ext/vlgothic/README diff --git a/Docs/legacy/license-ext/vlgothic/README.sazanami b/Docs/docs/legacy/license-ext/vlgothic/README.sazanami similarity index 100% rename from Docs/legacy/license-ext/vlgothic/README.sazanami rename to Docs/docs/legacy/license-ext/vlgothic/README.sazanami diff --git a/Docs/legacy/license-ext/vlgothic/README_J.mplus b/Docs/docs/legacy/license-ext/vlgothic/README_J.mplus similarity index 100% rename from Docs/legacy/license-ext/vlgothic/README_J.mplus rename to Docs/docs/legacy/license-ext/vlgothic/README_J.mplus diff --git a/Docs/legacy/midiman.wishlist b/Docs/docs/legacy/midiman.wishlist similarity index 100% rename from Docs/legacy/midiman.wishlist rename to Docs/docs/legacy/midiman.wishlist diff --git a/Docs/legacy/old_changelog.txt b/Docs/docs/legacy/old_changelog.txt similarity index 100% rename from Docs/legacy/old_changelog.txt rename to Docs/docs/legacy/old_changelog.txt diff --git a/Docs/legacy/opensource_simulators.txt b/Docs/docs/legacy/opensource_simulators.txt similarity index 100% rename from Docs/legacy/opensource_simulators.txt rename to Docs/docs/legacy/opensource_simulators.txt diff --git a/Docs/legacy/steps.lua b/Docs/docs/legacy/steps.lua similarity index 100% rename from Docs/legacy/steps.lua rename to Docs/docs/legacy/steps.lua diff --git a/Docs/legacy/versioning.txt b/Docs/docs/legacy/versioning.txt similarity index 100% rename from Docs/legacy/versioning.txt rename to Docs/docs/legacy/versioning.txt diff --git a/Docs/docs/stylesheets/mkdocs.css b/Docs/docs/stylesheets/mkdocs.css new file mode 100644 index 0000000000..d18a881d6e --- /dev/null +++ b/Docs/docs/stylesheets/mkdocs.css @@ -0,0 +1,9 @@ +:root { + --md-primary-fg-color: #614080; + --md-primary-fg-color--light: #614080; + --md-primary-fg-color--dark: #7950a1; +} + +[data-md-color-scheme=slate] { + --md-default-bg-color: #262626; +} \ No newline at end of file diff --git a/Docs/documentation/README.md b/Docs/documentation/README.md deleted file mode 100644 index 898e826194..0000000000 --- a/Docs/documentation/README.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -has_children: true -title: Etterna Documentation Overview ---- - -[Editing Site](editing_site.md) -- A brief overview of how this site is generated and how it can be configured. diff --git a/Docs/mkdocs.yml.in b/Docs/mkdocs.yml.in new file mode 100644 index 0000000000..9b80cb75c3 --- /dev/null +++ b/Docs/mkdocs.yml.in @@ -0,0 +1,52 @@ +# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json + +site_name: Etterna +site_description: Advanced cross-platform rhythm game focused on keyboard play +site_url: https://docs.etterna.dev +repo_url: https://github.com/etternagame/etterna +repo_name: Etterna +docs_dir: @PROJECT_SOURCE_DIR@/Docs/docs + +extra_css: + - stylesheets/mkdocs.css + +theme: + name: material + favicon: @PROJECT_SOURCE_DIR@/Docs/docs/favicon.ico + font: false + features: + - navigation.tabs + icon: + repo: fontawesome/brands/github-alt + palette: + - scheme: default + toggle: + icon: material/brightness-5 + name: Switch to dark mode + - scheme: slate + toggle: + icon: material/brightness-2 + name: Switch to light mode + +extra: + # Hide "Made with Material" in footer + generator: false + + # Bottom right footer icons + social: + - icon: simple/discord + link: https://discord.com/invite/etternaonline + name: Etterna Online + - icon: simple/discord + link: https://discord.gg/ZqpUjsJ + name: Etterna Dev Group + +nav: + - Welcome: 'README.md' + - Etterna Wiki: '' + - Developer Wiki: + - Building Etterna: 'Building.md' + - Crashpad: 'Crashpad.md' + - Bug Reporting: 'Bugreporting.md' + - Doxygen: 'doxygen/html/index.html' + - LDoc: 'ldoc/index.html' \ No newline at end of file diff --git a/Docs/style/doxygen/header.html b/Docs/style/doxygen/header.html new file mode 100644 index 0000000000..a662e21bd5 --- /dev/null +++ b/Docs/style/doxygen/header.html @@ -0,0 +1,87 @@ + + + + + + + + + + + $projectname: $title + + $title + + + + + + + + + $treeview + $search + $mathjax + $darkmode + + $extrastylesheet + + + + + + + +
+ + + +
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
$projectname $projectnumber +
+ +
$projectbrief
+ 		+
$projectbrief
+ 		$searchbox
$searchbox
+
+ + \ No newline at end of file diff --git a/Docs/style/doxygen/style.css b/Docs/style/doxygen/style.css new file mode 100644 index 0000000000..238bc13d6c --- /dev/null +++ b/Docs/style/doxygen/style.css @@ -0,0 +1,70 @@ +html { + --primary-color: #0ce3ac; + --primary-dark-color: #7929d2; + + --side-nav-background: #614080; + --side-nav-foreground: #ffffffe6; + --side-nav-fixed-width: 250px; + + --top-height: 250px; +} + + +@media (prefers-color-scheme: dark) { + html:not(.light-mode) { + color-scheme: dark; + + --primary-color: #0ce3ac; + --side-nav-background: #614080; + --page-background-color: #262626; + } +} + + +html.dark-mode { + color-scheme: dark; + + --primary-color: #0ce3ac; + --side-nav-background: #614080; + --page-background-color: #262626; +} + + +a:link, a:visited, a:hover, a:focus, a:active { + color: var(--link-color) !important; +} + +dl.section dd, dl.bug dd, dl.deprecated dd { + margin-inline-start: revert; +} + +.icon { + color: black; +} + +#top { + background: var(--side-nav-background); +} + +#titlearea { + padding-bottom: 0; +} + +#titlearea table { + width: 100%; +} + +#projectlogo img { + width: 200px; + max-height: none !important; +} + +#projectalign { + display: none; +} + +@media screen and (min-width: 768px) { + #doc-content { + padding-top: calc(var(--top-height) - 180px); + } +} \ No newline at end of file