Skip to content

Scripts to aggregate diagnostic data for the "Mathe für Nicht-Freaks" project

License

Notifications You must be signed in to change notification settings

gruenerBogen/MfNF-Diagnostic-Scripts

Repository files navigation

MfNF-Diagnostic-Scripts

Scripts to aggregate information on the articles of the Mathe für Nicht-Freaks project.

Scripts

Currently there are the following diagnostic scripts:

  • bad_finder.py: Find broken links and ankers on the Mathe für Nicht-Freaks project.

  • boxen_finder.py: Analyse the usage of te custom templates on the Mathe für Nicht-Freaks project.

  • double_usage_finder.py: Analyse the double use of contents on the Mathe für Nicht-Freaks project.

  • gallery_finder.py: Analyse the usage of galleries on the Mathe für Nicht-Freaks project.

  • ref_finder.py: Analyse the usage of references on the Mathe für Nicht-Freaks project.

  • table_finder.py: Analyse the usage of tables on the Mathe für Nicht-Freaks project

  • tex_macro_finder.py: Collect a list of all TeX-macros used in math environments on the Mathe für Nicht-Freaks project.

If you can’t be bothered to read the documentation (see below), you can just run the script with python3. That is run

python3 <script_name>

They have decent defaults. But if you want to use caching or comfortably store information elsewhere, you should take a brief look at the documentation.

Where can I get more information on the scripts?

Check the folder doc. You will find manpages for the individual scripts there.

I want to contribute something

Awesome! If you have something to contribute (e.g. a bug, an idea, a diagnostic script, etc.), just create an issue or a pull request. Ideally, take a look at CONTRIBUTING before doing so.

About

Scripts to aggregate diagnostic data for the "Mathe für Nicht-Freaks" project

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages