Data and Theme updates

Author: danwos

data/20221024_awesome.json data/20221025_awesome.json

@@ -9,5 +9,5 @@ Instead make it configurable by variables, like sphinx_type.
 Data
 ----
 
-.. needimport:: {{need_ipmort_file}}
+.. needimport:: {{need_import_file}}
    :filter: sphinx_type == "{{sphinx_type}}"

data/20221025_pypi_gh_data.json

@@ -163,4 +163,7 @@ div.dt-button-collection button.dt-button.active:not(.disabled) {
 table.NEEDS_DATATABLES, table.NEEDS_TABLE{
     max-width: inherit;
     width: inherit;
-}
+}
+div.md-grid {
+    max-width: 100rem !important;
+  }

docs/_awesome_templates/data_import.rst

@@ -19,6 +19,9 @@ Specific Need objects
    :featured: True
    :tags: needs
 
+.. needextend:: DOXYSPHINX
+   :featured: True
+
 .. needextend:: SPHINXCONTRIB-NEEDS
    :deprecated: True   
    :tags: needs
@@ -32,9 +35,16 @@ Specific Need objects
    :tags: needs
 
 .. needextend:: SPHINX-SIMPLEPDF
-   :featured: True
    :sphinx_type: extension
    :tags: pdf
 
 .. needextend:: SPHINX-IMMATERIAL
    :featured: True
+
+
+.. needextend:: SPHINX_DESIGN
+   :+tags: layout
+
+
+	
+

docs/_static/custom.css

@@ -16,7 +16,7 @@
 sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
 from projects import PROJECT_TAGS
 
-project = 'awesome-sphinx'
+project = 'Awesome-Sphinx'
 copyright = '2022, team useblocks'
 author = 'team useblockjs'
 
@@ -43,7 +43,7 @@
 html_js_files = ['custom.js']
 html_context = {
     'project_tags': PROJECT_TAGS,
-    'need_ipmort_file': os.getenv('AWESOMESPHINX_NEEDS_FILE', '/../data/20221024_awesome.json')
+    'need_import_file': os.getenv('AWESOMESPHINX_NEEDS_FILE', '/../data/20221025_awesome.json')
 }
 
 html_theme_options = {
@@ -90,6 +90,7 @@
         },
     ],
     "toc_title_is_page_title": True,
+    "toc_title": "Awesome Sphinx",
 }
 
 

docs/additions.rst

@@ -54,8 +54,8 @@ Use the export buttons to get the current view as a PDF or Excel file.
 The export takes filter and sorting into account.
 
 .. needtable::
-   :columns: id, title as "Name", content as "Description", sphinx_type as "Type", license, points, monthly as "Monthly downloads", release_days as "Days since last release", stars as "Stars"
-   :colwidths: 10, 20, 35,10, 5, 5, 5, 10, 5
+   :columns: id, package_summary as "Description", sphinx_type as "Type", tags, website_nice as "Website", license, points, monthly as "Monthly downloads", release_days as "Days since last release", stars as "Stars"
+   :colwidths: 10,45,5,10,5,5,5,5,5,5
    :style_row: awesome_[[copy('color')]]
 
 

docs/conf.py

@@ -1,4 +1,4 @@
-{% for tag, desc in project_tags.items() %}
+{% for tag, desc in project_tags.items()|sort() %}
 .. _tag_{{tag}}:
 
 {{tag|capitalize}}

docs/index.rst

@@ -25,15 +25,18 @@
 # List of of projects, which have set one of the above classifiers, but shall be ignored.
 # Mostly because they are not reallyy related to Sphinx or just use Sphinx for documentation.
 IGNORE_PROJECTS = [
-
+    "ALVEOLUS"
 ]
 
-# Dict of allowed tags for a project.
+# Dict of tags to document.
 # Is used to generate tag specific overviews.
 # Key is used for filtering, the value as documentation
 PROJECT_TAGS = {
     'needs': 'All `Sphinx-Needs <https://www.sphinx-needs.com/>`__ related extensions and maybe themes.',
-    'image_processing': 'Extensions dealing with images and their presentation.',
-    'layout':  'Extension which help to structure your dcument data e.g. by grids or dropdowns.',
+    'layout':  'Extensions which help to structure your dcument data e.g. by grids or dropdowns.',
     'pdf': 'Extensions which are dealing with PDFs.',
-}
+    'hacktoberfest': 'Projects, which are part of the `Hacktoberfest <https://hacktoberfest.com/>`__.',
+    'markdown': 'Extensions and tools, which support Markdown in Sphinx projects.',
+    'doxygen': 'Doxygen support inside Sphinx.',
+    'python': 'Support of the Python programming language',
+}

docs/tags.rst

@@ -8,6 +8,18 @@
 sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
 from projects import PROJECT_FILTERS, EXTRA_PROJECTS, IGNORE_PROJECTS
 
+# A list of tags, which shall not be set, as they are too commonly used.
+PROJECT_IGNORE_TAGS = [
+    "sphinxcontrib",
+    "sphinx",
+    "documentation",
+    "sphinx-theme",
+    "sphinx-extension",
+    "theme",
+    "extension",
+    "documentation-tool",
+    "documentation-generator",
+]
 
 ##################################################
 # PYPI_JSON.PY configs

projects.py

@@ -12,7 +12,7 @@
 from awesome_config import *
 
 
-KEY = "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"
+KEY = os.environ['GH_KEY']
 
 
 def get_gh_topics(name, gh_project, results, counter):
@@ -33,8 +33,8 @@ def get_gh_topics(name, gh_project, results, counter):
 
 
 
-print(f'Reading pypi data from {PYPI_FILE}')
-with open(PYPI_FILE, 'r') as f:
+print(f'Reading pypi data from {JSON_FILE}')
+with open(JSON_FILE, 'r') as f:
     pypi_data = json.load(f)
 
 gh_projects={}
@@ -61,7 +61,7 @@ def get_gh_topics(name, gh_project, results, counter):
     gh_urls_clean = []
     for url in gh_urls:
         if url is not None and 'github.com' in url and '/issues' not in url:
-            url_clean = url.replace('https://github.com/', '').strip('/')
+            url_clean = url.replace('https://github.com/', '').replace('https://github.com/', '').strip('/')
             gh_urls_clean.append(url_clean)
 
     if gh_urls_clean:
@@ -83,6 +83,10 @@ def get_gh_topics(name, gh_project, results, counter):
         threads[name].start()
         counter += 1
 
+for thre in threads.values():
+    thre.join()
+
+
 print(f'Received {len(results)} tag-results from GitHub')
 
 for name, project in pypi_data.items():
@@ -98,5 +102,3 @@ def get_gh_topics(name, gh_project, results, counter):
 
 print('Done. Exit now!')
 
-# for repo in g.get_user().get_repos():
-#     print(repo.name)

scripts/awesome_config.py

@@ -71,7 +71,10 @@ def classifiers_check(value, classifiers):
         overall = 0
 
     try:
-        tags = data['awesome_stats']['tags']
+        tags = []
+        for tag in data['awesome_stats']['tags']:
+            if tag not in PROJECT_IGNORE_TAGS:
+                tags.append(tag)
     except KeyError:
         tags = []