← Back to team overview

kicad-developers team mailing list archive

Re: [PATCH] Add logo to documentation

 

I'm OK with the short logo image.  This would probably look better than
the redundant KiCad.

On 06/17/2018 08:53 AM, John Beard wrote:
> Sadly I don't think there is a way to set the logo alt text in doxygen
> (so it would still read "KiCad" when the image is not displayed, for
> screen readers, when copy-pasted and it when search engines index it).
> 
> Alternatively, use the square icon rather than the text logo and keep
> the title as it is?
> 
> Cheers,
> 
> John
> 
> On Wed, Jun 13, 2018 at 11:18 PM, Wayne Stambaugh <stambaughw@xxxxxxxxx
> <mailto:stambaughw@xxxxxxxxx>> wrote:
> 
>     I agree.  The double KiCad does look a bit odd but I do like the
>     KiCad logo embedded in the docs.
> 
>     On 06/13/2018 06:00 PM, Nick Østergaard wrote:
> 
>         Maybe we need to remove the word KiCad from the title, as  it
>         essentially reads  "[KiCad] KiCad Pcbnew Python Scripting"
> 
> 
>         2018-06-13 21:12 GMT+02:00 John Beard <john.j.beard@xxxxxxxxx
>         <mailto:john.j.beard@xxxxxxxxx> <mailto:john.j.beard@xxxxxxxxx
>         <mailto:john.j.beard@xxxxxxxxx>>>:
> 
>             Sorry, I had a line commented in a local commit to avoid a
>         costly
>             re-build of the docstrings when I didn't need them to be
>         (the doc
>             dependencies aren't managed by CMake, it just always runs the
>             targets, which is fine for CI).
> 
>             The attached should be better (difference is a lack of a "#
>         " before
>             DEPENDS xml-to-docstrings)
> 
>             Cheers,
> 
>             John
> 
>             On Wed, Jun 13, 2018 at 8:04 PM, Wayne Stambaugh
>             <stambaughw@xxxxxxxxx <mailto:stambaughw@xxxxxxxxx>
>         <mailto:stambaughw@xxxxxxxxx <mailto:stambaughw@xxxxxxxxx>>> wrote:
> 
>                 John,
> 
>                 I am getting the following error when I try to apply
>         your patch:
> 
>                 $ git am --ignore-whitespace <
>                
>         /c/Users/wstambaugh/Documents/Archive/temp/kicad/patches/0001-Documentation-add-logo-to-Doxygen-pages.patch
>                 Applying: Documentation: add logo to Doxygen pages
>                 error: patch failed: pcbnew/CMakeLists.txt:533
>                 error: pcbnew/CMakeLists.txt: patch does not apply
>                 Patch failed at 0001 Documentation: add logo to Doxygen
>         pages
>                 Use 'git am --show-current-patch' to see the failed patch
>                 When you have resolved this problem, run "git am
>         --continue".
>                 If you prefer to skip this patch, run "git am --skip"
>         instead.
>                 To restore the original branch and stop patching, run
>         "git am
>                 --abort".
> 
>                 It appears to be choking on the pcbnew/CMakeFile.txt.  Is it
>                 possible
>                 that you have other changes to this file that are not in the
>                 master branch?
> 
>                 Cheers,
> 
>                 Wayne
> 
>                 On 6/13/2018 1:50 PM, John Beard wrote:
>                  > Hi,
>                  >
>                  > This patch adds a small KiCad logo to the three doxygen
>                 documentation
>                  > targets (C++, dev docs and Python docs) for a little
>         bit more
>                 flair.
>                  >
>                  > The image itself is put in the /Documentation dir,
>         but it's
>                 not really
>                  > important to the process where it goes.
>                  >
>                  > Cheers,
>                  >
>                  > John
>                  >
>                  >
>                  > _______________________________________________
>                  > Mailing list: https://launchpad.net/~kicad-developers
>         <https://launchpad.net/~kicad-developers>
>                 <https://launchpad.net/~kicad-developers
>         <https://launchpad.net/~kicad-developers>>
>                  > Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>         <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx>
>                 <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx
>         <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx>>
>                  > Unsubscribe : https://launchpad.net/~kicad-developers
>         <https://launchpad.net/~kicad-developers>
>                 <https://launchpad.net/~kicad-developers
>         <https://launchpad.net/~kicad-developers>>
>                  > More help   : https://help.launchpad.net/ListHelp
>         <https://help.launchpad.net/ListHelp>
>                 <https://help.launchpad.net/ListHelp
>         <https://help.launchpad.net/ListHelp>>
>                  >
> 
>                 _______________________________________________
>                 Mailing list: https://launchpad.net/~kicad-developers
>         <https://launchpad.net/~kicad-developers>
>                 <https://launchpad.net/~kicad-developers
>         <https://launchpad.net/~kicad-developers>>
>                 Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>         <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx>
>                 <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx
>         <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx>>
>                 Unsubscribe : https://launchpad.net/~kicad-developers
>         <https://launchpad.net/~kicad-developers>
>                 <https://launchpad.net/~kicad-developers
>         <https://launchpad.net/~kicad-developers>>
>                 More help   : https://help.launchpad.net/ListHelp
>         <https://help.launchpad.net/ListHelp>
>                 <https://help.launchpad.net/ListHelp
>         <https://help.launchpad.net/ListHelp>>
> 
> 
> 
>             _______________________________________________
>             Mailing list: https://launchpad.net/~kicad-developers
>         <https://launchpad.net/~kicad-developers>
>             <https://launchpad.net/~kicad-developers
>         <https://launchpad.net/~kicad-developers>>
>             Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>         <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx>
>             <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx
>         <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx>>
>             Unsubscribe : https://launchpad.net/~kicad-developers
>         <https://launchpad.net/~kicad-developers>
>             <https://launchpad.net/~kicad-developers
>         <https://launchpad.net/~kicad-developers>>
>             More help   : https://help.launchpad.net/ListHelp
>         <https://help.launchpad.net/ListHelp>
>             <https://help.launchpad.net/ListHelp
>         <https://help.launchpad.net/ListHelp>>
> 
> 
> 


Follow ups

References