Arc Forumnew | comments | leaders | submitlogin
Arcfn.com documentation scripts pushed to anarki
7 points by kens 4953 days ago | 6 comments
A couple people suggested that I open-source the scripts I use to generate the Arc documentation at http://arcfn.com/doc. Since I don't have time to keep the documentation up to date, that seems like a good idea to me.

I submitted the scripts to Anarki and they are at https://github.com/nex3/arc/tree/master/extras/arcfn-docs

The README gives a brief overview of how to run the scripts to generate the HTML documentation. I spent a bit of time to get everything into a runnable form, but there are a lot of rough edges.

Hopefully these scripts will be useful to someone...



1 point by aw 4952 days ago | link

There was a previous discussion that if Arc documentation was in Anarki, some people might like to work on it. The documentation is now ready to be worked on, if people still want to do that.

If you'd like to work on the documentation, make changes to the template files (or rewrite the code which generates the documentation, etc., whatever you want), commit your changes to Anarki, and the resulting output will be published at http://arcdoc.eval.to/

(Currently this is a manual process for me to do the publish step so the output won't appear right away. I will most likely implement an automatic process at the point that someone does start working on the documentation in Anarki; as a) I won't need to write an automatic process if it turns out that no one does want to work on the documentation; and b) actually having to publish manually will motivate me to implement the automatic process really quick :-)

Details are in the README: https://github.com/nex3/arc/raw/master/extras/arcfn-docs/REA...

A couple of notes:

- I'm happy to publish the documentation in the subdomain of eval.to, but we don't have to; if you have a better domain all you'd need to do is add a CNAME to your DNS for us to publish under your domain.

- I didn't know how to run Anarki from the documentation directory so the "generate.sh" that I checked in uses the hackinator; to use Anarki instead to generate the documentation just fix generate.sh to use Anarki.

-----

2 points by aw 4953 days ago | link

I took an initial stab at uploading these to http://arcdoc.eval.to/

That's just an alias for the S3 bucket because I happened to have the eval.to domain handy, but it would be easy to put it under some other domain instead.

Some pages seem to be missing, for example I don't seem to have or have generated anaphoric.html.

Once I have things figured out I'll fix up some kind of auto deployment system; in the meantime I'll continue to republish after any commits made to anarki.

-----

2 points by kens 4953 days ago | link

I've added some of the missing template files to github. Let me know if there is anything else missing - it's all kind of a mess of files on my end from when I tried to move to arc3.

-----

1 point by aw 4952 days ago | link

Looking much better! The only thing I see missing now is that foundation-doc.tem wants to import docs/hdr1.txt; there's an docs/hdr1.html but not a docs/hdr1.txt.

-----

1 point by kens 4951 days ago | link

I've added hdr.txt; hdr1.txt was going to be a new header, but never actually existed.

-----

2 points by aw 4953 days ago | link

Thank you!

-----