Logo

Contents:

  • Installation
  • Usage
  • Developer Docs
    • Contributing Guide
    • The `utils` module
    • The `nester_log` module
    • The `commands` module
  • The `utils` module
  • The `nester_log` module
  • The `commands` module
  • Supported Languages
Nester
  • Developer Docs
  • View page source

Developer Docs

These docs are a compilation of all of Nester’s components aswell as information you need to contribute to Nester.

Contents:

  • Contributing Guide
    • Clone the Repository
    • Install Requirements
    • Use Pull Request and Issue Templates
    • Feature Requests
    • Keeping Style
    • Documentation
    • Submitting a Pull Request
  • The `utils` module
    • clean()
    • create_structure()
    • detect_languages()
    • get_project_dir()
    • initialize_git_repository()
    • load_json()
    • rename_project_directory()
    • validate_structure()
  • The `nester_log` module
    • ProjectLogFormatter
    • check_log_for_duplicate()
    • clean_orphaned_entries()
    • create_log_file_if_none()
    • find_all_projects()
    • print_log_to_table()
    • remove_log_entry()
    • rename_log_entry()
  • The `commands` module
    • clean_project()
    • create_project()
    • print_log()
    • rename_project()
    • validate_project()
Previous Next

© Copyright 2023, Christopher Hock aka ByteOtter.

Built with Sphinx using a theme provided by Read the Docs.