Opened 4 years ago

Last modified 3 years ago

#4693 enhancement assigned

pydoctor generated documentation on the website should use common stylesheet

Reported by: glyph Owned by: thijs
Priority: normal Milestone:
Component: website Keywords: documentation
Cc: thijs Branch: branches/howto-styling-4693
(diff, github, buildbot, log)
Author: thijs Launchpad Bug:

Description

When I was setting up tm.tl, I realized that it's pretty easy to add the Twisted Matrix Labs template frosting to a web page. The pydoctor template that we use on the website should include that.

Attachments (1)

screen1.png (82.6 KB) - added by thijs 3 years ago.

Download all attachments as: .zip

Change History (11)

comment:1 Changed 3 years ago by <automation>

  • Owner oubiwann deleted

comment:2 Changed 3 years ago by thijs

  • Owner set to thijs

comment:3 Changed 3 years ago by thijs

  • Author set to thijs
  • Branch set to branches/howto-styling-4693

(In [33085]) Branching to 'howto-styling-4693'

comment:4 Changed 3 years ago by thijs

(In [33086]) Use css style from website in template for howto documents. refs #4693

Changed 3 years ago by thijs

comment:5 Changed 3 years ago by thijs

  • Cc thijs added
  • Keywords documentation review added
  • Owner thijs deleted

Below's a screenshot of a howto with the website css style applied. As you can see there are some images missing (that have a relative reference in the css file) and I wonder how to handle this with lore. It basically needs to make relative links in every html page for static images..

We could also simply decide to get rid of the top banner where all the images are and only use the text styling.


comment:6 follow-up: Changed 3 years ago by exarkun

Huh. The release document looks wrong, since it does direct the release manager to use doc/core/howto/template.tpl to generate the website documentation. Instead, it should be directing the release manager to use doc/core/howto/website-template.tpl.

In turn, it seems template.tpl has gotten somewhat out of date for a few reasons:

  1. It is missing the version footer.
  2. It is missing at sitemeter and google analytics (adding this would remove a couple gross manual steps from the release process).
  3. It should have a link to the latest version of the docs, as was just recently added to the api docs pages.

These are all separate issues, but implementing the website style in the website template still makes more sense than implementing it in the default template.

I haven't really read the diff closely apart from this, and I'm not going to comment on the particulars of the css.

comment:7 Changed 3 years ago by jonathanj

I'm a little confused, the ticket talks about "pydoctor generated documentation" but the howtos are Lore docs.

I assume that moving to the Sphinx documentation is still not really close to being on the cards if we're updating the styling of Lore documentation.

comment:8 follow-up: Changed 3 years ago by exarkun

  • Keywords review removed
  • Owner set to thijs

I'm a little confused, the ticket talks about "pydoctor generated documentation" but the howtos are Lore docs.

Good point. The branch seems to implement the wrong thing entirely.

comment:9 in reply to: ↑ 6 Changed 3 years ago by thijs

  • Status changed from new to assigned

Replying to exarkun:

Huh. The release document looks wrong, since it does direct the release manager to use doc/core/howto/template.tpl to generate the website documentation.

I opened #5380 for this.

comment:10 in reply to: ↑ 8 Changed 3 years ago by thijs

Replying to exarkun:

I'm a little confused, the ticket talks about "pydoctor generated documentation" but the howtos are Lore docs.

Good point. The branch seems to implement the wrong thing entirely.

Fair enough. I started with trying to add the header to the API documentation but couldn't find a way to specify a custom html/css template to pydoctor and then implemented it for the howtos instead.

Note: See TracTickets for help on using tickets.