SevgiAkten / pycellga

Cellular Genetic Algorithms in Python.
https://sevgiakten.github.io/pycellga/
MIT License
2 stars 1 forks source link

__dict__ entries in the documentation system #60

Closed jbytecode closed 2 months ago

jbytecode commented 2 months ago

Here is the example screenshot:

Screenshot from 2024-08-13 19-07-27

Can we prevent the documentation system generating the information about unused object fields such like __dict__ ?

jbytecode commented 2 months ago

In commit

https://github.com/SevgiAkten/pycellga/commit/00ba8ea972b1f91822e9b5d0c546d888f782b8d0

it seems you are editing the documentation by hand, but, the html files should be machine-generated.

So you have to find an automatic way of getting rid of these unused text.

SevgiAkten commented 2 months ago

Not manually, but by adding code to conf.py. Actually, the dict field no longer appears in the index.html after the changes, but when accessed through the link, the changes are not reflected. I'll take care of this as well.

jbytecode commented 2 months ago

CI reports the error as

Configuration file: none
To use retry middleware with Faraday v2.0+, install `faraday-retry` gem
  Conversion error: Jekyll::Converters::Scss encountered an error while converting 'assets/css/style.scss':
                    No such file or directory @ dir_chdir0 - /github/workspace/docs
/usr/local/bundle/gems/jekyll-sass-converter-1.5.2/lib/jekyll/converters/scss.rb:86:in `chdir': No such file or directory @ dir_chdir0 - /github/workspace/docs (Errno::ENOENT)
    from /usr/local/bundle/gems/jekyll-sass-converter-1.5.2/lib/jekyll/converters/scss.rb:86:in `sass_load_paths'
    from /usr/local/bundle/gems/jekyll-sass-converter-1.5.2/lib/jekyll/converters/scss.rb:[11](https://github.com/SevgiAkten/pycellga/actions/runs/10373772695/job/28719664680#step:4:12)4:in `sass_configs'
    from /usr/local/bundle/gems/jekyll-sass-converter-1.5.2/lib/jekyll/converters/scss.rb:119:in `convert'
    from /usr/local/bundle/gems/jekyll-3.10.0/lib/jekyll/renderer.rb:101:in `block in convert'
    from /usr/local/bundle/gems/jekyll-3.10.0/lib/jekyll/renderer.rb:99:in `each'
    from /usr/local/bundle/gems/jekyll-3.10.0/lib/jekyll/renderer.rb:99:in `reduce'
    from /usr/local/bundle/gems/jekyll-3.10.0/lib/jekyll/renderer.rb:99:in `convert'
    from /usr/local/bundle/gems/jekyll-3.10.0/lib/jekyll/renderer.rb:83:in `render_document'
    from /usr/local/bundle/gems/jekyll-3.10.0/lib/jekyll/renderer.rb:62:in `run'
    from /usr/local/bundle/gems/jekyll-3.10.0/lib/jekyll/site.rb:479:in `render_regenerated'
    from /usr/local/bundle/gems/jekyll-3.10.0/lib/jekyll/site.rb:472:in `block in render_pages'
    from /usr/local/bundle/gems/jekyll-3.10.0/lib/jekyll/site.rb:471:in `each'
    from /usr/local/bundle/gems/jekyll-3.10.0/lib/jekyll/site.rb:471:in `render_pages'
    from /usr/local/bundle/gems/jekyll-3.10.0/lib/jekyll/site.rb:192:in `render'
    from /usr/local/bundle/gems/jekyll-3.10.0/lib/jekyll/site.rb:71:in `process'
    from /usr/local/bundle/gems/jekyll-3.10.0/lib/jekyll/command.rb:28:in `process_site'
    from /usr/local/bundle/gems/jekyll-3.10.0/lib/jekyll/commands/build.rb:65:in `build'
    from /usr/local/bundle/gems/jekyll-3.10.0/lib/jekyll/commands/build.rb:36:in `process'
    from /usr/local/bundle/gems/github-pages-232/bin/github-pages:70:in `block (3 levels) in <top (required)>'
    from /usr/local/bundle/gems/mercenary-0.3.6/lib/mercenary/command.rb:220:in `block in execute'
    from /usr/local/bundle/gems/mercenary-0.3.6/lib/mercenary/command.rb:220:in `each'
    from /usr/local/bundle/gems/mercenary-0.3.6/lib/mercenary/command.rb:220:in `execute'
    from /usr/local/bundle/gems/mercenary-0.3.6/lib/mercenary/program.rb:42:in `go'
    from /usr/local/bundle/gems/mercenary-0.3.6/lib/mercenary.rb:19:in `program'
    from /usr/local/bundle/gems/github-pages-232/bin/github-pages:6:in `<top (required)>'
    from /usr/local/bundle/bin/github-pages:25:in `load'
    from /usr/local/bundle/bin/github-pages:25:in `<main>'
Error:  Logging at level: debug GitHub Pages: github-pages v232 GitHub Pages: jekyll v3.10.0 Theme: jekyll-theme-primer Theme source: /usr/local/bundle/gems/jekyll-theme-primer-0.6.0 Requiring: jekyll-github-metadata Requiring: jekyll-seo-tag Requiring: jekyll-coffeescript Requiring: jekyll-commonmark-ghpages Requiring: jekyll-gist Requiring: jekyll-github-metadata Requiring: jekyll-paginate Requiring: jekyll-relative-links Requiring: jekyll-optional-front-matter Requiring: jekyll-readme-index Requiring: jekyll-default-layout Requiring: jekyll-titles-from-headings GitHub Metadata: Initializing... Source: /github/workspace/./docs Destination: /github/workspace/./docs/_site Incremental build: disabled. Enable with --incremental Generating... Generating: JekyllOptionalFrontMatter::Generator finished in 2.0298e-05 seconds. Generating: JekyllReadmeIndex::Generator finished in 1.[14](https://github.com/SevgiAkten/pycellga/actions/runs/10373772695/job/28719664680#step:4:15)91e-05 seconds. Generating: Jekyll::Paginate::Pagination finished in 6.852e-06 seconds. Generating: JekyllRelativeLinks::Generator finished in 3.4584e-05 seconds. Generating: JekyllDefaultLayout::Generator finished in 1.6411e-05 seconds. Generating: JekyllTitlesFromHeadings::Generator finished in 1.[15](https://github.com/SevgiAkten/pycellga/actions/runs/10373772695/job/28719664680#step:4:16)42e-05 seconds. Rendering: assets/css/style.scss Pre-Render Hooks: assets/css/style.scss Rendering Markup: assets/css/style.scss github-pages 232 | Error: No such file or directory @ dir_chdir0 - /github/workspace/docs
jbytecode commented 2 months ago

Not manually, but by adding code to conf.py. Actually, the dict field no longer appears in the index.html after the changes, but when accessed through the link, the changes are not reflected. I'll take care of this as well.

So it's about this issue: https://github.com/SevgiAkten/pycellga/issues/61

SevgiAkten commented 2 months ago

This issue has been resolved and is reflected in the updated documentation system.