Comments (10)
These documentation creation problems are why I have been re-writing the system for producing documentation. It is called Collection-raku-documentation.
It should work out of the box by calling RakuDoc in an empty directory. There is a need to create a clone of this repository (but you have already done that) and to point the config file there.
I wrote the Renderer (raku-pod-render) based on the BigFile
code. However BigFile
died from bit rot some time ago, unless it has been revived.
Since all of the rendering of the podfiles are in templates, it should be relatively straightforward (though tedious) to create the Mode (see collection) for a single documentation file and to generate a pdf or epub file directly. I have simply not had the time yet to do this.
from documentable.
I can't see how this would happen. That command downloads a tar file and unzips it. Here's the content
Maybe we should check that it's been uncompressed correctly. Also I don't know why assets changes name instead of being used directly...
I'll try and add a test for this anyway.
from documentable.
I see an "assetpack.db" file but it's an ASCII file with contents:
$ cat assetpack.db
[sass:/sass/style.scss]
checksum=ab742940db
format=css
minified=0
from documentable.
By the way I tried:
$ documentable clean
and got:
Cleaning up the directory...
rm: cannot remove 'app.pl': No such file or directory
The spawned command ' rm -rf html && rm -rf assets && rm -rf highlights \
&& rm app.pl && rm app-start && rm Makefile \
&& rm -rf template
' exited unsuccessfully (exit code: 1)
in sub RUN-MAIN at /usr/local/rakudo.d/share/perl6/site/sources/8C56C68E804C20D14911B45EA26CF2450E29CFC8 (Documentable::CLI) line 28
in block <unit> at /usr/local/rakudo.d/share/perl6/site/resources/1A2F2F2753AC23B9ED83E45593B48A7F719F159B line 3
in sub MAIN at /usr/local/rakudo.d/share/perl6/site/bin/documentable line 3
in block <unit> at /usr/local/rakudo.d/share/perl6/site/bin/documentable line 1
from documentable.
What's the name of the downloaded archive file?
Okay, I can see the messages in the http chunk and it shows getting "assets.tar.gz" from amazon, unpacking it, and "saving' it, bit nothing found in my dir. I'll try to paste the whole message here.
from documentable.
Now it works! But the file "assets.db" doesn't get removed with a "documentable clean."
from documentable.
Trying to see the docs served:
$ make run
Starting local server…
./app-start
Server available at http://127.0.0.1:3000
[2019-09-02 13:34:39.80146] [10680] [info] Copying assets...
[2019-09-02 13:34:39.80704] [10680] [info] ...done
[2019-09-02 13:34:56.42005] [10680] [debug] GET "/" (612fddc8)
[2019-09-02 13:34:56.42091] [10680] [debug] Routing to a callback
[2019-09-02 13:34:56.42119] [10680] [debug] Static file "/index.html" not found
[2019-09-02 13:34:56.42225] [10680] [debug] Template "not_found.development.html.ep" not found
[2019-09-02 13:34:56.42287] [10680] [debug] Template "not_found.html.ep" not found
[2019-09-02 13:34:56.42307] [10680] [debug] Rendering template "mojo/debug.html.ep"
[2019-09-02 13:34:56.43784] [10680] [debug] Your secret passphrase needs to be changed
[2019-09-02 13:34:56.43920] [10680] [debug] 404 Not Found (0.019168s, 52.170/s)
<snip after waiting a short while>
from documentable.
I will take a look at:
- Mojolicious passphare, ... => Though I have to say those are not important warnings, we are using the development server after all. Right now html files are served using nginx so it's not a problem.
- Fails in 'documentable clean' and assets.db not getting removed. (assets.db is an intermediate file used by sass command I think, I am not sure)
from documentable.
from documentable.
I'm having the same problem. No Makefile, app-start or app.pl files. I do have type-graph.txt and documentable.json
from documentable.
Related Issues (20)
- The current version uses ~2000 seconds to build from scratch HOT 5
- Does not test clean on Rakudo HEAD HOT 3
- Links to editable pages are not generated correctly now HOT 2
- «make init-highlights» does not work with latest versions of node
- There are no instructions to regenerate the files in the doc/ directory
- Index entries do not match the actual anchor when special characters are used HOT 2
- test 'not regenerate all subindexes' doesn't actually test that HOT 3
- Remove redundant `$!filename` from `Documentable::Primary` HOT 2
- 404.html changes even when an update is done.
- generate-error-page and generate-home-page use the same code: DRY
- Update routine does not ensure that files are modified only once
- Upgrade dependency
- broken links in individual routine pages if the links are just fragment-urls in the pod document
- Test failures HOT 3
- Index terms can be duplicated
- File::Temp dependencies invalid HOT 7
- Typo in diagnostic output
- "make html" broken in raku/doc HOT 3
- SparkyCI build fails HOT 3
- Clearly define the process
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from documentable.