search

wsvincent / awesome-django

A curated list of awesome things related to Django
http://awesomedjango.org
Creative Commons Zero v1.0 Universal
9.5k stars 1.31k forks source link

Add Django-Classy-Doc #277

Closed nanuxbe closed 3 months ago

nanuxbe commented 4 months ago

name: Add a new project about: Suggest a new Django project for the Awesome Django list title: "Django-Classy-Doc"

Project Information

  1. Project Name: Django-Classy-Doc

  2. Project URL: https://github.com/nanuxbe/django-classy-doc

  3. Description:

Create a documentation site in the style of CCBV and CDRF but for your own project code.

Criteria

Please answer the following questions about the project you are submitting. This will help us evaluate if the project should be included in the Awesome Django list.

Note: If your project is only a few months old or has under 50 to 100 stars on GitHub, it may NOT meet the criteria for inclusion in the Awesome Django list. We recommend that you promote your project more and then consider a submission at a later date when it has gained more visibility and community support.

  1. Is the project new?

    • [X] Yes
    • [ ] No

  2. How long has the project been maintained? 1 month

  3. How many releases has it had if it's a library or package? 3

  4. Are you the author or are you submitting the project on behalf of a company?

    • [X] I am the author
    • [ ] I am submitting on behalf of a company
    • [ ] Other (please specify)

  5. What makes it awesome?

For years now, I've been relying on CCBV and CDRF for most of the projects I've worked on, having at least one of those 2 sites open next to my editor. I've always yearned for the same kind of documentation for my own code when working on larger projects with complex inheritance. This library bridges this gap and gives me access to that kind of documentation.

Additional Information

Please provide any additional information you believe is relevant to the project or its evaluation for inclusion in the Awesome Django list. This might include information about the project's documentation, test coverage, community support, or any unique features that set it apart from other Django projects.

Although the project is relatively new and only has a few stars for now, it received quite a warm welcome when it was unveiled at DjangoCon Europe of this year (2024) with most people I've talked too telling me they've also wanted something like this for years

jefftriplett commented 3 months ago

Thank you for the submission. This project definitely is really useful, and I'm going to include it in hopes we see more and better websites built using it.