diff --git a/README.md b/README.md index c21a520..2f333f4 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,10 @@ so that pip can compile the dependencies of this project: apk add gcc g++ python3-dev musl-dev linux-headers ``` +See also the discussion on +[libsass-python](https://github.com/sass/libsass-python/issues/391#issuecomment-2555670485) +about musl wheels + You can then build the documentation like this. The command MUST be run from the root of the repo. @@ -46,12 +50,21 @@ the above command rebuilds EVERYTHING. ## TODO -- [ ] Lint references -- [ ] incremental compilation -- [ ] references to specific labels or headings -- [ ] Frontmatter parsing - - [ ] "next" link through frontmatter - - [ ] "previous" link automatic +- [ ] Capabilities of RAIMARK + - [ ] Lint references + - [ ] incremental compilation + - [ ] references to specific labels or headings + - [ ] Frontmatter parsing + - [x] "next" link through frontmatter + - [x] "previous" link automatic + - [ ] display journey TOC + - [ ] API reference generation +- [ ] RAIDOC Content + - [ ] Deepdive on proxies + - [ ] Demos of various raimad designs + - [ ] ...potentially others? + - [ ] Documentation for maintaining raimad + - [ ] Documentation for maintaining radoc/raidoc/raimark ## License diff --git a/doc/pages/collaboration.md b/doc/pages/collaboration.md index 5b757e7..a81d977 100644 --- a/doc/pages/collaboration.md +++ b/doc/pages/collaboration.md @@ -7,23 +7,38 @@ RAIMAD packages are nothing more the standard Python packages. That means you can install them with tools like `pip`. +## Using a RAIMAD package + +If you would just like to make use of a RAIMAD package +within your designs, +you can install it using pip. +For example, if you wanted to install +the sample +[`rai_smiley` package](https://github.com/tifuun/rai_smiley), +you could do it like so + +```shell +pip install git+https://github.com/tifuun/rai_smiley +``` + ## Working on other people's repos -One of the common tasks you might find yourself doing -as a RAIMAD user is changing code in existing packages. -Although every project is free to use whatever source control -and packaging system they want, -we expect most RAIMAD work to happen in Python packages -hosted on git repositories. +If you want to not only use a package, +but also change its code +(for example, if you want to contribute new components to an existing package), +you should first *clone* +the repository using git, +and then install it using pip editable mode, +like so: -Therefore, in general, contributing code to a RAIMAD repo -follows these steps: +```shell +git clone https://github.com/tifuun/rai_smiley +pip install -e ./rai_smiley +``` -1. Clone the git repo -1. Install the package container in the repo with `pip` in `editable` mode. -1. Make your changes to the code -1. Preview your changes by testing the component with `raimad export` -1. Commit the changes or submit a pull request. +Installing a package in editable mode means that any changes +that you make in your local copy of the package +will be reflected from within Python when you import it. The screencast below demonstrates these steps by making a simple change in the sample @@ -118,7 +133,7 @@ that and starts with `rai_`. After that, by using the sample -[`rai_smiley`](https://github.com/tifuun/rai_smiley), +[`rai_smiley`](https://github.com/tifuun/rai_smiley) as a reference, set up the file structure of your package and upload it to a git repository. diff --git a/doc/templ/root.html b/doc/templ/root.html index 44f0d6a..b07d349 100644 --- a/doc/templ/root.html +++ b/doc/templ/root.html @@ -22,8 +22,8 @@

RAIDOC

HOME SEARCH + -->
diff --git a/pyproject.toml b/pyproject.toml index 4e4c2e3..752a031 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,12 +4,18 @@ build-backend = "setuptools.build_meta" [project] name = "raidoc" -version = "1.2.0.6" +version = "1.2.0.9" description = "Documentation for RAIMAD" authors = [ {name = "maybetree", email = "maybetree48@proton.me"} ] -license = { text = "I haven't decided yet" } +license = { file = "LICENSE-GPL.txt" } +license-files = [ + { file = "LICENSE-GPL3.txt", text = "GNU GPL v3" }, + { file = "LICENSE-FDL.txt", text = "GNU FDL" }, + { file = "LICENSE-CC0.txt", text = "CC0" } +] + readme = "README.md" classifiers = [ 'Programming Language :: Python :: 3',