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

API docs theme styling setup #69

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Conversation

travisavc
Copy link
Collaborator

Fixed main logo in /docs: #37

Created both a pydoctor and typedoc folder in root for continued theming
Setup pydoctor overrides for stylesheet/head of templates --- /api now has an orange header and white text to demonstrate styling is setup and ready for a deeper attack
Typedoc theming is next...continued effort!

@travisavc travisavc requested a review from thesteve0 March 5, 2025 16:31
@travisavc travisavc requested a review from a team as a code owner March 5, 2025 16:31
@travisavc
Copy link
Collaborator Author

@thesteve0 not sure why this is failing in the deploy preview / build process --- locally both main and this feature branch succeed during build.sh and mkdocs serve

@thesteve0
Copy link
Contributor

Looks like it is an XML parsing issue.

 writing html to /home/runner/work/voxel51-docs/temp_workspace/api_docs using pydoctor.templatewriter.writer.TemplateWriter
    return expatbuilder.parseString(string)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/xml/dom/expatbuilder.py", line 922, in parseString
    return builder.parseString(string)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/xml/dom/expatbuilder.py", line 220, in parseString
    parser.Parse(string, True)
xml.parsers.expat.ExpatError: not well-formed (invalid token): line 13, column 71

And there is a different problem that is cause by how I am doing the builds right now. The jupyter notebooks are getting rewritten in place and so git sees this as changed files. I don't want those files checked in as changed. This is for me to fix.

I am not going to merge this for now. Let's talk on Monday to see how we can debug that parse error here.

In terms of the jupyter notebook builds, for now we have to be more selective about our git commits and just do the files we touch. I need to fix this ASAP, hopefully @tom-vx51 or @swheaton have a brilliant idea on how to fix this in the build.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants