Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

create a wiki as code repo and pages that documents events and their params #45

Open
hadamrd opened this issue Apr 2, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@hadamrd
Copy link
Owner

hadamrd commented Apr 2, 2024

To install wiki as code chosen
pip install mkdocs mkdocs-material

make new project :
mkdocs new pydofus2_wiki
cd pydofus2_wiki

Edit the mkdocs.yml to create a doc for events
site_name: Pydofus2 Events Documentation
theme:
name: material

nav:

  • Home: index.md
  • Events:
    • Job Experience Update: events/job_experience_update.md

    Add other events here

creer un dossier pour rassembler les fichier .yml des doc d'events and add first .md for the job_experience event
events/job_experience_update.md

Job Experience Update Event

Description

This event is fired when a job gains experience.

Parameters

  • oldJobXp: The previous job experience value.
  • jobExp: An instance of JobExperience containing the job ID and the gained experience.

Example Usage

KernelEventsManager().on(KernelEvent.JobExperienceUpdate, self.onJobExperience)
def onJobExperience(self, event, oldJobXp, jobExp):
    Logger().info(f"Job {jobExp.jobId} has gained {jobExp.jobXP} xp")

To start server

mkdocs serve

@hadamrd hadamrd added this to Grinder Apr 2, 2024
@hadamrd hadamrd moved this to Backlog in Grinder Apr 2, 2024
@hadamrd hadamrd moved this from Backlog to In progress in Grinder Apr 2, 2024
@hadamrd hadamrd self-assigned this Apr 2, 2024
@hadamrd hadamrd added the documentation Improvements or additions to documentation label Apr 2, 2024
@hadamrd hadamrd moved this from In progress to In review in Grinder Apr 3, 2024
@hadamrd hadamrd moved this from In review to Done in Grinder Apr 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

No branches or pull requests

1 participant