search

scribe-org / Scribe-Data

Wikidata, Wiktionary and Wikipedia language data extraction
GNU General Public License v3.0
23 stars 25 forks source link

Check out how to add the GPL3.0 license to the tops of Scribe-Data files without having it displayed in the docs #128

Closed andrewtavis closed 3 months ago

andrewtavis commented 5 months ago

Terms

Description

Something that's advised for GPL3.0 code is for a short license notice to be put at the top of each file such the copy left notice will be maintained even if the codebase and the file are separated. An issue with this for Scribe-Data is that the files are being used directly in the documentation, and we don't want to the license notice at the top of each page in the docs. One thing that came up in the recent sync is that maybe we can include HTML tags for a dropdown around the notice such that it's hidden in the docs unless someone opens it. Aside from this, it'd be great to see if we can automatically remove this somehow so the docs don't get overly messy...

If we can't figure this out, then we'll just not put the license at the top of files, which isn't advised, but is legally ok :)

Contribution

Happy to work with someone on this and assist as needed!

mhmohona commented 5 months ago

So I asked chatgpt about it, and it suggested that we can use custom css for doing this. Thats way, it will be only file, but will be hidden in doc.

andrewtavis commented 5 months ago

Thanks for looking into this, @mhmohona! Custom CSS how? Wouldn't we need a page element to hide? I'm not really sure where we'd get that from in a multi line Python comment, but definitely something to explore!

andrewtavis commented 3 months ago

Closed by d6d2127 :) Thanks for the suggestion here, @mhmohona! Worked like a charm to use custom CSS to hide the HTML comments within the docs! 😊