jak-project/.gitignore

71 lines
762 B
Plaintext
Raw Normal View History

# for CMake
/Testing
2020-08-22 22:30:12 -04:00
# for clion
cmake-build-debug/*
cmake-build-debug--o0/*
2020-08-22 22:30:12 -04:00
.idea/*
build/*
2021-01-03 17:57:12 -05:00
decompiler_out/*
decompiler_out2/*
logs/*
# for vscode/clangd
.cache/*
.DS_Store
# wsl apparently builds to here?
linux-default/
# for Nix
/result*
\#*#
.#*#
*.pyc
2021-08-16 10:43:12 -04:00
# output from our tools
*.bin
*.log
*.p2s
savestate-out/
savestate_out/
failures/
ee-results*.json
search-results.json
.env
/search-results.json
2021-08-16 10:43:12 -04:00
# graphics debug
debug_out/
glb_out/
gfx_dumps/
screenshots/
2021-08-16 10:43:12 -04:00
# game stuff
game_config/*
imgui.ini
# website stuff
node_modules/
# texture replacements
texture_replacements/*
# generated cmake files
svnrev.h
ci-artifacts/
out/build/
__pycache__/
# sqlite stuff
*.db
*.db-journal
# backup files from OpenMaya
*.bak
docs: Automatically generate documentation from goal_src code (#2214) This automatically generates documentation from goal_src docstrings, think doxygen/java-docs/rust docs/etc. It mostly supports everything already, but here are the following things that aren't yet complete: - file descriptions - high-level documentation to go along with this (think pure markdown docs describing overall systems that would be co-located in goal_src for organizational purposes) - enums - states - std-lib functions (all have empty strings right now for docs anyway) The job of the new `gen-docs` function is solely to generate a bunch of JSON data which should give you everything you need to generate some decent documentation (outputting markdown/html/pdf/etc). It is not it's responsibility to do that nice formatting -- this is by design to intentionally delegate that responsibility elsewhere. Side-note, this is about 12-15MB of minified json for jak 2 so far :) In our normal "goal_src has changed" action -- we will generate this data, and the website can download it -- use the information to generate the documentation at build time -- and it will be included in the site. Likewise, if we wanted to include docs along with releases for offline viewing, we could do so in a similar fashion (just write a formatting script to generate said documentation). Lastly this work somewhat paves the way for doing more interesting things in the LSP like: - whats the docstring for this symbol? - autocompleting function arguments - type checking function arguments - where is this symbol defined? - etc Fixes #2215
2023-02-20 19:49:37 -05:00
# docs
/jak1-*.json
/jak2-*.json