Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change documentation to markdown #101

Merged
merged 75 commits into from
Jun 7, 2020
Merged

Change documentation to markdown #101

merged 75 commits into from
Jun 7, 2020

Conversation

edyoung
Copy link
Member

@edyoung edyoung commented May 13, 2020

We now have a directory 'manual/content' containing the docs in markdown format. Setup.py uses hugo to generate html docs in manual/public. The generated doc and associated files are installed when you run setup.py installed.

TODO:

  • update website

edyoung and others added 29 commits May 12, 2020 23:04
No executable files ending in get.py are being installed.
* examples: allow custom formula filename in cmake

* [#7] example experiment: formula with arbitrary precision support

* MP example: add swap idiom and other improvements

* add debug information to cpp examples compilation
* typo

* experiment to benchmark arbitrary precision math

* was running 3 benchmarks

* update #112 (#113)

* install google benchmark globally in exmaples infrastructure

* update exmaples readme

* disable frequency scaling during benchmark

* remove i/o from benchmark loop

* benchmark several different bit lengths

* Basis for discussion on available math libraries

* notes

Co-authored-by: Alberto Gonzalez <[email protected]>
gnofract4d-logo.png is size 640x640.

Individual icons created using ImageMagick, e.g.:
magick gnofract4d-logo.png -strip -resize 256x256 logo/256x256/gnofract4d.png

Install the 48x48 icon into pixmaps.
Report linting and testing results separately. Only run pylint once.
* tidy worker initialization

* remove unused typedef

* worker: improve AA comparison

* fix docker test script

* remove duplicate extern declaration

* workers: refactor common members into base

* remove some completed todo's

* organize fractfunc initialization and members

* unravel coupling: pointfunc - site

* refactor: extract calculation options into a struct to ease initializers

* remove duplicate

* move rgba type basic operations to its type definition

* remove some temporaries in stworker->work

* review worker member names

* remove unneeded worker alloc members

* remove pointFunc factory

* update some old-fashion idioms on fractfunc and stats

* prefix fractfunc private members

* avoid clearing fates twice when autoupdating iters and period tolerance

* reorganize and narrow down public/private worker interface

* remove unused, mark experimental and review old fashioned code on stfractworker

* calcoptions: add some comments and move asynchronous back to where it belongs

* prevent uninitialized members on fractFunc

* remove initialization success flag on workers

* fix comment

* reorganize fractfunct members and remove unused
new directory 'manual' generates standalone HTML for manual
@edyoung edyoung changed the title WIP: create draft of documentation in markdown Change documentation to markdown Jun 6, 2020
@edyoung edyoung merged commit ae9f710 into master Jun 7, 2020
@mindhells mindhells mentioned this pull request Jun 9, 2020
@mindhells
Copy link
Member

@edyoung I think you removed doc/mathlibs.md by mistake, did you or did you put it elsewhere?
That file you created it contained a comparison table with all the arbitrary precision support libraries.

@edyoung
Copy link
Member Author

edyoung commented Jun 29, 2020

Oops, will restore when I have some time.

cjmayo added a commit to cjmayo/gnofract4d that referenced this pull request Oct 13, 2020
Used in the section "Viewing in Four Dimensions".

Deleted in:
ae9f710 ("Change documentation to markdown (fract4d#101)", 2020-06-07)
cjmayo added a commit that referenced this pull request Oct 15, 2020
Used in the section "Viewing in Four Dimensions".

Deleted in:
ae9f710 ("Change documentation to markdown (#101)", 2020-06-07)
cjmayo added a commit to cjmayo/gnofract4d that referenced this pull request Dec 11, 2020
Not used since:
ae9f710 ("Change documentation to markdown (fract4d#101)", 2020-06-07)
cjmayo added a commit to cjmayo/gnofract4d that referenced this pull request Dec 11, 2020
Not used since:
ae9f710 ("Change documentation to markdown (fract4d#101)", 2020-06-07)
edyoung pushed a commit that referenced this pull request Dec 13, 2020
* Correct title of Save High-Res Image shortcut

* Remove unused MainWindow.get_all_actions()

Not used since:
ae9f710 ("Change documentation to markdown (#101)", 2020-06-07)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants