Doc generation #4
Conversation
FlynnD273
force-pushed
the
doc-generation
branch
from
c1762c0 to
2535adc
Compare
FlynnD273
force-pushed
the
doc-generation
branch
from
2535adc to
b61b462
Compare
|
Yup, that should be sorted now |
| @@ -77,7 +77,7 @@ def generate_docs | |||
| # The order of these functions will determine the order of preference | |||
| # when looking up symbols e.g. double backticks | |||
| # DO NOT CHANGE THE ORDER UNLESS YOU KNOW WHAT YOU ARE DOING | |||
| generate_docs_c | |||
| # generate_docs_c | |||
There was a problem hiding this comment.
Is there a reason this has been disabled? We definitely want this one enabled - don't want to be using the preview docs.
| @@ -47,7 +47,8 @@ def language | |||
|
|
|||
| def process_summary(zipfile, summary) | |||
| summary.css('tbody tr').each do | row | | |||
| name = row.at_css('td.colFirst').content | |||
| print(row) | |||
| @@ -55,6 +55,8 @@ def cleanup | |||
| def download_and_extract(zip, folder) | |||
| open(zip) do | zf | | |||
| Zip::File.open(zf.path) do | zipfile | | |||
| print("extracted from ", zf.path) | |||
| @@ -29,7 +29,7 @@ def initialize(site, source) | |||
| @path = '/docs/pebblekit-android/' | |||
| open(source) do | zf | | |||
| Zip::File.open(zf.path) do | zipfile | | |||
| entry = zipfile.glob('javadoc/overview-summary.html').first | |||
| entry = zipfile.glob('javadoc/index.html').first | |||
There was a problem hiding this comment.
This breaks doc generation for Android in my local testing. What was the motivation for this change?
| <a href="{{ group.url }}">{{ group.name }}</a> | ||
| {% if group.children.size > 0 %} |
There was a problem hiding this comment.
I'm not convinced this is a necessary change - the only place I'm seeing it have an effect is in the Rocky docs, where it adds the timeout/interval functions to the sidebar. Those pages are very small though, and they're already documented on the Rocky docs index page, so I don't think that adds much value.
| @@ -95,7 +95,12 @@ def process_data(node, mapping, platform) | |||
|
|
|||
| def process_typedef(node, mapping, platform) | |||
| process_return_type(node, mapping, platform) | |||
| @data[platform]['argsstring'] = node.at_css('argsstring').content.to_s | |||
| argsstring = node.at_css('argsstring') | |||
There was a problem hiding this comment.
Are there issues with this path as is? I haven't run into errors in this path in my local testing, but it's entirely possible I missed something.
| @@ -7,6 +7,7 @@ ALGOLIA_API_KEY= | |||
| ALGOLIA_SEARCH_KEY= | |||
| ALGOLIA_PREFIX=devsite-dev- | |||
| GOOGLE_ANALYTICS= | |||
| GOOGLE_API= | |||
There was a problem hiding this comment.
What uses this environment variable?
There was a problem hiding this comment.
tbh I don't remember 😅 I don't think it's used currently.
| @@ -1,45 +1,48 @@ | |||
| {% comment %} | |||
| Copyright 2025 Google LLC | |||
| Copyright 2025 Google LLC | |||
There was a problem hiding this comment.
Can you avoid reformatting the header blocks if possible? Just to keep diffs clean.
|
I think I'm going to close this, I don't see how this PR has any meaningful changes at the moment. It was made a long time ago, if any of the like... 2 actual changes were helpful, they'll be here if I eventually revisit this. But I suspect most of the issues actually stemmed from my not generating the Android docs properly or something? |
Not really expecting this to get merged, but this is just my work that I did over the duration of the Hackathon to try to get docs generation working. I've got all but the Android and iOS docs building and displaying all properly.